@lightningjs/renderer 1.0.0 → 2.0.0

package/src/main-api/Renderer.ts

@@ -21,7 +21,6 @@
 import type { EffectMap, ShaderMap } from '../core/CoreShaderManager.js';
 import type { ExtractProps, TextureMap } from '../core/CoreTextureManager.js';
 import { EventEmitter } from '../common/EventEmitter.js';
-import { Inspector } from './Inspector.js';
 import { assertTruthy, isProductionEnvironment } from '../utils.js';
 import { Stage } from '../core/Stage.js';
 import { CoreNode, type CoreNodeProps } from '../core/CoreNode.js';
@@ -40,6 +39,11 @@ import type {
   EffectDescUnion,
 } from '../core/renderers/webgl/shaders/effects/ShaderEffect.js';
 import type { TextureMemoryManagerSettings } from '../core/TextureMemoryManager.js';
+import type { CanvasTextRenderer } from '../core/text-rendering/renderers/CanvasTextRenderer.js';
+import type { SdfTextRenderer } from '../core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
+import type { WebGlCoreRenderer } from '../core/renderers/webgl/WebGlCoreRenderer.js';
+import type { CanvasCoreRenderer } from '../core/renderers/canvas/CanvasCoreRenderer.js';
+import type { Inspector } from './Inspector.js';
 
 /**
  * An immutable reference to a specific Shader type
@@ -181,21 +185,29 @@ export interface RendererMainSettings {
   numImageWorkers?: number;
 
   /**
-   * Enable inspector
+   * DOM Inspector
    *
    * @remarks
-   * When enabled the renderer will spawn a inspector. The inspector will
-   * replicate the state of the Nodes created in the renderer and allow
-   * inspection of the state of the nodes.
+   * The inspector will replicate the state of the Nodes created
+   * in the renderer and allow inspection of the state of the nodes.
    *
-   * @defaultValue `false` (disabled)
    */
-  enableInspector?: boolean;
+  inspector: typeof Inspector | undefined;
 
   /**
-   * Renderer mode
+   * Renderer Engine
+   *
+   * @remarks
+   * The renderer engine to use. Spawns a WebGL or Canvas renderer.
+   * WebGL is more performant and supports more features. Canvas is
+   * supported on most platforms.
+   *
+   * Note: When using CanvasCoreRenderer you can only use
+   * CanvasTextRenderer. The WebGLCoreRenderer supports
+   * both CanvasTextRenderer and SdfTextRenderer for Text Rendering.
+   *
    */
-  renderMode?: 'webgl' | 'canvas';
+  renderEngine: typeof CanvasCoreRenderer | typeof WebGlCoreRenderer;
 
   /**
    * Quad buffer size in bytes
@@ -203,6 +215,36 @@ export interface RendererMainSettings {
    * @defaultValue 4 * 1024 * 1024
    */
   quadBufferSize?: number;
+
+  /**
+   * Font Engines
+   *
+   * @remarks
+   * The font engines to use for text rendering. CanvasTextRenderer is supported
+   * on all platforms. SdfTextRenderer is a more performant renderer.
+   * When using `renderEngine=CanvasCoreRenderer` you can only use `CanvasTextRenderer`.
+   * The `renderEngine=WebGLCoreRenderer` supports both `CanvasTextRenderer` and `SdfTextRenderer`.
+   *
+   * This setting is used to enable tree shaking of unused font engines. Please
+   * import your font engine(s) as follows:
+   * ```
+   * import { CanvasTextRenderer } from '@lightning/renderer/canvas';
+   * import { SdfTextRenderer } from '@lightning/renderer/webgl';
+   * ```
+   *
+   * If both CanvasTextRenderer and SdfTextRenderer are provided, the first renderer
+   * provided will be asked first if it can render the font. If it cannot render the
+   * font, the next renderer will be asked. If no renderer can render the font, the
+   * text will not be rendered.
+   *
+   * **Note** that if you have fonts available in both engines the second font engine
+   * will not be used. This is because the first font engine will always be asked first.
+   *
+   * @defaultValue '[]'
+   *
+   *
+   */
+  fontEngines: (typeof SdfTextRenderer | typeof CanvasTextRenderer)[];
 }
 
 /**
@@ -288,9 +330,10 @@ export class RendererMain extends EventEmitter {
       numImageWorkers:
         settings.numImageWorkers !== undefined ? settings.numImageWorkers : 2,
       enableContextSpy: settings.enableContextSpy ?? false,
-      enableInspector: settings.enableInspector ?? false,
-      renderMode: settings.renderMode ?? 'webgl',
+      inspector: settings.inspector,
+      renderEngine: settings.renderEngine,
       quadBufferSize: settings.quadBufferSize ?? 4 * 1024 * 1024,
+      fontEngines: settings.fontEngines,
     };
     this.settings = resolvedSettings;
 
@@ -299,7 +342,7 @@ export class RendererMain extends EventEmitter {
       appHeight,
       deviceLogicalPixelRatio,
       devicePhysicalPixelRatio,
-      enableInspector,
+      inspector,
     } = resolvedSettings;
 
     const deviceLogicalWidth = appWidth * deviceLogicalPixelRatio;
@@ -325,10 +368,11 @@ export class RendererMain extends EventEmitter {
       enableContextSpy: this.settings.enableContextSpy,
       fpsUpdateInterval: this.settings.fpsUpdateInterval,
       numImageWorkers: this.settings.numImageWorkers,
-      renderMode: this.settings.renderMode,
+      renderEngine: this.settings.renderEngine,
       textureMemory: resolvedTxSettings,
       eventBus: this,
       quadBufferSize: this.settings.quadBufferSize,
+      fontEngines: this.settings.fontEngines,
     });
 
     // Extract the root node
@@ -351,8 +395,8 @@ export class RendererMain extends EventEmitter {
     targetEl.appendChild(canvas);
 
     // Initialize inspector (if enabled)
-    if (enableInspector && !isProductionEnvironment()) {
-      this.inspector = new Inspector(canvas, resolvedSettings);
+    if (inspector && !isProductionEnvironment()) {
+      this.inspector = new inspector(canvas, resolvedSettings);
     }
   }
 

package/dist/src/core/TextureList.js

@@ -1,34 +0,0 @@
-class TextureList {
-    head = null;
-    length = 0;
-    add(texture) {
-        if (texture.prev)
-            this.length++;
-    }
-    remove(texture) {
-        if (texture.prev) {
-            texture.prev.next = texture.next;
-        }
-        else {
-            this.head = texture.next;
-        }
-        if (texture.next) {
-            texture.next.prev = texture.prev;
-        }
-        texture.next = null;
-        texture.prev = null;
-        this.length--;
-    }
-    forEach(callback) {
-        let current = this.head;
-        while (current !== null) {
-            callback(current.texture);
-            current = current.next;
-        }
-    }
-    get size() {
-        return this.length;
-    }
-}
-export {};
-//# sourceMappingURL=TextureList.js.map

package/dist/src/core/TextureList.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TextureList.js","sourceRoot":"","sources":["../../../src/core/TextureList.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW;IACP,IAAI,GAAwB,IAAI,CAAC;IACjC,MAAM,GAAG,CAAC,CAAC;IAEnB,GAAG,CAAC,OAAqB;QACvB,IAAI,OAAO,CAAC,IAAI;YAEhB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,OAAqB;QAC1B,IAAI,OAAO,CAAC,IAAI,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;SAClC;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;SAC1B;QACD,IAAI,OAAO,CAAC,IAAI,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;SAClC;QACD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QACpB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,QAAoC;QAC1C,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;QACxB,OAAO,OAAO,KAAK,IAAI,EAAE;YACvB,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC1B,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;SACxB;IACH,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF"}

package/dist/src/core/renderers/webgl/newShader/abcMock.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/core/renderers/webgl/newShader/abcMock.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=abcMock.js.map

package/dist/src/core/renderers/webgl/newShader/abcMock.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"abcMock.js","sourceRoot":"","sources":["../../../../../../src/core/renderers/webgl/newShader/abcMock.ts"],"names":[],"mappings":""}

package/dist/src/effectsMock.d.ts

@@ -1,13 +0,0 @@
-import type { ShaderMap } from "./core/CoreShaderManager.js";
-/**
- * Shader Controller Base Interface
- *
- * @remarks
- * Used directly this interface is like an `any` type for Shader Controllers.
- * But it is also used as a base for more specific Shader Controller interfaces.
- */
-export interface AnyShaderController {
-    type: keyof ShaderMap;
-    shader: any;
-    props: any;
-}

package/dist/src/effectsMock.js

@@ -1,62 +0,0 @@
-function createEffect(name, type, props) {
-    return {
-        name,
-        type,
-        props
-    };
-}
-const renderer = {};
-// RoundedRectangle Shader
-const node2 = renderer.createNode({
-    shader: renderer.createShader('RoundedRectangle', {
-        radius: 100
-    })
-});
-node2.shader.props.radius = 200;
-node2.animate({
-    shaderProps: {
-        radius: 200
-    }
-});
-// Dynamic Shader
-class Effect {
-    props;
-    constructor(props) {
-        this.props = props;
-    }
-}
-class SomeEffect extends Effect {
-    constructor(props) {
-        super(props);
-    }
-}
-class SomeEffect2 extends Effect {
-    constructor(props) {
-        super(props);
-    }
-}
-const node = renderer.createNode({
-    shader: renderer.createDynamicShader([
-        createEffect('e1', 'SomeEffect', { color: 0xff0000 }),
-        createEffect('e2', 'SomeEffect2', { color2: 0xff0000 }),
-    ])
-});
-node.animate({
-    x: 12,
-    shaderProps: {
-        e1: {
-            color: 0x00ff00
-        },
-        e2: {
-            color2: 0x00ff00
-        },
-    }
-});
-node.shader.props.e1.color = 0x00ff00;
-// Default Shader
-const node3 = renderer.createNode({
-    x: 0,
-    y: 0
-});
-export {};
-//# sourceMappingURL=effectsMock.js.map

package/dist/src/effectsMock.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"effectsMock.js","sourceRoot":"","sources":["../../src/effectsMock.ts"],"names":[],"mappings":"AAaA,SAAS,YAAY,CAAoD,IAAU,EAAE,IAAU,EAAE,KAA8D;IAC7J,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,KAAK;KACN,CAAC;AACJ,CAAC;AA0JD,MAAM,QAAQ,GAAa,EAAc,CAAC;AAuB1C,0BAA0B;AAC1B,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;IAChC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,kBAAkB,EAAE;QAChD,MAAM,EAAE,GAAG;KACZ,CAAC;CACH,CAAC,CAAC;AAEH,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;AAEhC,KAAK,CAAC,OAAO,CAAC;IACZ,WAAW,EAAE;QACX,MAAM,EAAE,GAAG;KACZ;CACF,CAAC,CAAC;AAiBH,iBAAiB;AACjB,MAAM,MAAM;IACV,KAAK,CAAU;IAEf,YAAY,KAA8B;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,MAAM,UAAW,SAAQ,MAAM;IAK7B,YAAY,KAA0B;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CACF;AAED,MAAM,WAAY,SAAQ,MAAM;IAK9B,YAAY,KAA2B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CACF;AAgBD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC/B,MAAM,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QACnC,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;QACrD,YAAY,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;KACxD,CAAC;CACH,CAAC,CAAA;AAGF,IAAI,CAAC,OAAO,CAAC;IACX,CAAC,EAAE,EAAE;IACL,WAAW,EAAE;QACX,EAAE,EAAE;YACF,KAAK,EAAE,QAAQ;SAChB;QACD,EAAE,EAAE;YACF,MAAM,EAAE,QAAQ;SACjB;KACF;CACF,CAAC,CAAC;AAEH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,GAAG,QAAQ,CAAC;AAuBtC,iBAAiB;AACjB,MAAM,KAAK,GAAU,QAAQ,CAAC,UAAU,CAAC;IACvC,CAAC,EAAE,CAAC;IACJ,CAAC,EAAE,CAAC;CACL,CAAC,CAAC"}

package/dist/src/test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/test.js

@@ -1,4 +0,0 @@
-const goodHighlight = 1; // <--- Correct syntax highlightning for `const` keyword
-const badHighlight = 1; // <--- Incorrect syntax highlightning for `const` keyword
-export {};
-//# sourceMappingURL=test.js.map

package/dist/src/test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["../../src/test.ts"],"names":[],"mappings":"AAGA,MAAM,aAAa,GAAG,CAAC,CAAC,CAAC,wDAAwD;AAMjF,MAAM,YAAY,GAAG,CAAC,CAAC,CAAC,0DAA0D"}