Skip to content

v2.0.0

Choose a tag to compare

@wouterlucas wouterlucas released this 23 Aug 10:57
· 822 commits to main since this release

Breaking Changes!

Support for Tree Shakable Canvas/WebGL renderer and Font Engines and importable inspector have changes to the way you initialize the Lightning 3 renderer.

It is required to import your desired render engine (WebGL or Canvas) and font engine(s) (SDF or Canvas) to provide those on setup when initializing the renderer as follows:

 const renderer = new RendererMain(
    {
      appWidth,
      appHeight,
      boundsMargin: [100, 100, 100, 100],
      deviceLogicalPixelRatio: logicalPixelRatio,
      devicePhysicalPixelRatio: physicalPixelRatio,
      clearColor: 0x00000000,
      fpsUpdateInterval: logFps ? 1000 : 0,
      enableContextSpy,
      inspector,
      renderEngine:
        renderMode === 'webgl' ? WebGlCoreRenderer : CanvasCoreRenderer,
      fontEngines: [SdfTextRenderer, CanvasTextRenderer],
      ...customSettings,
    },
    'app',
  )

Where inspector, WebGlCoreRenderer, CanvasCoreRenderer, SdfTextRenderer and CanvasTextRenderer are imported:

WebGL renderers:

import {
  WebGlCoreRenderer,
  SdfTextRenderer,
} from '@lightningjs/renderer/webgl';

Canvas renderers:

import {
  CanvasCoreRenderer,
  CanvasTextRenderer,
} from '@lightningjs/renderer/canvas';

Inspector:

import { Inspector } from '@lightningjs/renderer/inspector';

What's Changed

New Contributors

Full Changelog: v1.0.1...v2.0.0