@lightningjs/renderer 3.0.4 → 3.0.5

package/src/core/renderers/canvas/CanvasRenderer.ts

@@ -83,7 +83,19 @@ export class CanvasRenderer extends CoreRenderer {
     }
 
     const hasTransform = ta !== 1;
-    const hasClipping = clippingRect.w !== 0 && clippingRect.h !== 0;
+    const clippingValid = clippingRect.valid === true;
+
+    // If the clipping rect is valid but zero-area, the node is fully clipped — skip rendering
+    if (
+      clippingValid === true &&
+      clippingRect.w === 0 &&
+      clippingRect.h === 0
+    ) {
+      return;
+    }
+
+    const hasClipping =
+      clippingValid === true && clippingRect.w !== 0 && clippingRect.h !== 0;
     const shader = node.props.shader;
     const hasShader = shader !== null;
 
@@ -146,6 +158,9 @@ export class CanvasRenderer extends CoreRenderer {
       const tintColor = parseColor(color);
       if (textureType !== TextureType.subTexture) {
         const image = (texture.ctxTexture as CanvasTexture).getImage(tintColor);
+        if (image === null) {
+          return;
+        }
         this.context.globalAlpha = tintColor.a ?? node.worldAlpha;
         this.context.drawImage(image, tx, ty, width, height);
         this.context.globalAlpha = 1;
@@ -154,6 +169,9 @@ export class CanvasRenderer extends CoreRenderer {
       const image = (
         (texture as SubTexture).parentTexture.ctxTexture as CanvasTexture
       ).getImage(tintColor);
+      if (image === null) {
+        return;
+      }
       const props = (texture as SubTexture).props;
 
       this.context.globalAlpha = tintColor.a ?? node.worldAlpha;

package/src/core/renderers/canvas/CanvasTexture.ts

@@ -21,6 +21,7 @@ import type { Dimensions } from '../../../common/CommonTypes.js';
 import { assertTruthy } from '../../../utils.js';
 import { formatRgba, type IParsedColor } from '../../lib/colorParser.js';
 import { CoreContextTexture } from '../CoreContextTexture.js';
+import type { Texture } from '../../textures/Texture.js';
 
 export class CanvasTexture extends CoreContextTexture {
   protected image:
@@ -36,10 +37,23 @@ export class CanvasTexture extends CoreContextTexture {
     | undefined;
 
   async load(): Promise<void> {
+    // Capture textureData synchronously before any await - a pending
+    // freeTextureDataTask microtask could null textureSource.textureData
+    // during the first async suspension, causing onLoadRequest to fail.
+    const textureData = this.textureSource.textureData;
+    assertTruthy(textureData?.data, 'Texture data is null before load');
+
     this.textureSource.setState('loading');
 
     try {
-      const size = await this.onLoadRequest();
+      const size = await this.onLoadRequest(textureData.data);
+
+      // Guard against the texture being freed while the load was in flight
+      if (this.textureSource.state === 'freed') {
+        this.image = undefined;
+        return;
+      }
+
       this.textureSource.setState('loaded', size);
       this.textureSource.freeTextureData();
       this.updateMemSize();
@@ -82,9 +96,11 @@ export class CanvasTexture extends CoreContextTexture {
 
   getImage(
     color: IParsedColor,
-  ): ImageBitmap | HTMLCanvasElement | HTMLImageElement {
+  ): ImageBitmap | HTMLCanvasElement | HTMLImageElement | null {
     const image = this.image;
-    assertTruthy(image, 'Attempt to get unloaded image texture');
+    if (image === undefined) {
+      return null;
+    }
 
     if (color.isWhite) {
       if (this.tintCache) {
@@ -133,10 +149,9 @@ export class CanvasTexture extends CoreContextTexture {
     return canvas;
   }
 
-  private async onLoadRequest(): Promise<Dimensions> {
-    assertTruthy(this.textureSource?.textureData?.data, 'Texture data is null');
-    const { data } = this.textureSource.textureData;
-
+  private async onLoadRequest(
+    data: NonNullable<NonNullable<Texture['textureData']>['data']>,
+  ): Promise<Dimensions> {
     // TODO: canvas from text renderer should be able to provide the canvas directly
     // instead of having to re-draw it into a new canvas...
     if (data instanceof ImageData) {
@@ -144,7 +159,7 @@ export class CanvasTexture extends CoreContextTexture {
       canvas.width = data.width;
       canvas.height = data.height;
       const ctx = canvas.getContext('2d');
-      if (ctx) ctx.putImageData(data, 0, 0);
+      if (ctx !== null) ctx.putImageData(data, 0, 0);
       this.image = canvas;
       return { w: data.width, h: data.height };
     } else if (

package/src/core/renderers/webgl/WebGlShaderNode.ts

@@ -62,6 +62,7 @@ export class WebGlShaderNode<
     undefined;
   private valueKey: string = '';
   uniforms: UniformCollection = {
+    hasStoredUniforms: false,
     single: {},
     vec2: {},
     vec3: {},
@@ -83,6 +84,7 @@ export class WebGlShaderNode<
       this.update = () => {
         if (this.props === undefined) {
           this.updater!(this.node as CoreNode, this.props);
+          this.updateUniformUsage();
           return;
         }
 
@@ -106,12 +108,14 @@ export class WebGlShaderNode<
         }
         //create empty uniform collection when calculating new values
         this.uniforms = {
+          hasStoredUniforms: false,
           single: {},
           vec2: {},
           vec3: {},
           vec4: {},
         };
         this.updater!(this.node as CoreNode);
+        this.updateUniformUsage();
         stage.shManager.setShaderValues(
           this.valueKey,
           this.uniforms as unknown as Record<string, unknown>,
@@ -120,6 +124,26 @@ export class WebGlShaderNode<
     }
   }
 
+  updateUniformUsage(): void {
+    for (const _ in this.uniforms.single) {
+      this.uniforms.hasStoredUniforms = true;
+      return;
+    }
+    for (const _ in this.uniforms.vec2) {
+      this.uniforms.hasStoredUniforms = true;
+      return;
+    }
+    for (const _ in this.uniforms.vec3) {
+      this.uniforms.hasStoredUniforms = true;
+      return;
+    }
+    for (const _ in this.uniforms.vec4) {
+      this.uniforms.hasStoredUniforms = true;
+      return;
+    }
+    this.uniforms.hasStoredUniforms = false;
+  }
+
   /**
    * Sets the value of a RGBA variable
    * @param location

package/src/core/renderers/webgl/WebGlShaderProgram.ts

@@ -258,12 +258,12 @@ export class WebGlShaderProgram implements CoreShaderProgram {
     }
 
     const shader = renderOp.shader as WebGlShaderNode;
-    if (shader.props !== undefined) {
+    const uniforms = shader.uniforms;
+
+    if (uniforms.hasStoredUniforms === true) {
       /**
        * loop over all precalculated uniform types
        */
-      const uniforms = shader.uniforms;
-
       for (const key in uniforms.single) {
         const { method, value } = uniforms.single[key]!;
         this.glw[method as keyof UniformSet1Param](key, value as never);

package/src/core/renderers/webgl/internal/ShaderUtils.ts

@@ -42,6 +42,7 @@ export type Vec4 = [number, number, number, number];
 export type UniformValue = SingleValue | Vec2 | Vec3 | Vec4;
 
 export interface UniformCollection {
+  hasStoredUniforms: boolean;
   single: Record<string, Uniform<SingleValue>>;
   vec2: Record<string, Uniform<Vec2>>;
   vec3: Record<string, Uniform<Vec3>>;

package/src/core/textures/ImageTexture.ts

@@ -143,6 +143,24 @@ export class ImageTexture extends Texture {
   }
 
   override async getTextureSource(): Promise<TextureData> {
+    // Compressed textures are not supported by the Canvas2D renderer.
+    // Fail fast here before incurring a network fetch or binary decode.
+    if (this.txManager.renderer?.mode === 'canvas') {
+      const { src, type } = this.props;
+      if (
+        type === 'compressed' ||
+        (typeof src === 'string' && isCompressedTextureContainer(src) === true)
+      ) {
+        const err = new Error(
+          `ImageTexture: Compressed textures are not supported in Canvas2D render mode (src: ${String(
+            src,
+          )})`,
+        );
+        this.setState('failed', err);
+        return { data: null };
+      }
+    }
+
     let resp: TextureData;
     try {
       resp = await this.determineImageTypeAndLoadImage();

package/src/core/textures/Texture.ts

@@ -252,6 +252,11 @@ export abstract class Texture extends EventEmitter {
       return false;
     }
 
+    // Don't cleanup a texture that is in the process of loading
+    if (this.state === 'loading') {
+      return false;
+    }
+
     // Don't cleanup if not renderable
     if (this.renderable === true) {
       return false;
@@ -353,6 +358,7 @@ export abstract class Texture extends EventEmitter {
    */
   free(): void {
     this.ctxTexture?.free();
+    this.ctxTexture = undefined;
   }
 
   /**

package/dist/src/core/lib/fps.d.ts

@@ -1,15 +0,0 @@
-/**
- * Class that keeps track of the invocations of Context methods when
- * the `enableContextSpy` renderer option is enabled.
- */
-export interface FrameCounter {
-    start: number;
-    end: number;
-    frameCount: number;
-    frames: Record<number | string, number>;
-    increment: (frameDelta: number) => void;
-    get averageFps(): number;
-}
-export declare function setFrameBuckets(newBuckets: number[]): void;
-export declare function setFpsInterval(newInterval: number): void;
-export declare function createFrameCounter(frameTime: number): FrameCounter;

package/dist/src/core/lib/fps.js

@@ -1,62 +0,0 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast Cable Communications Management, LLC.
- *
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-let buckets = [20, 40, 60, 80, 100];
-let overflowBucketLabel = '>' + buckets[buckets.length - 1];
-let fpsInterval = 1000; // 1 second
-const frameCounter = {
-    start: 0,
-    end: 0,
-    frameCount: 0,
-    frames: {},
-    increment(frameDelta) {
-        this.frameCount++;
-        for (let i = 0; i < buckets.length; i++) {
-            const bucket = buckets[i];
-            if (frameDelta <= bucket) {
-                this.frames[bucket]++;
-                return;
-            }
-        }
-        this.frames[overflowBucketLabel]++;
-    },
-    get averageFps() {
-        //calculate fps based on frame count and elapsed time
-        return this.frameCount / (this.end - this.start) * 1000;
-    }
-};
-export function setFrameBuckets(newBuckets) {
-    buckets = newBuckets;
-    overflowBucketLabel = '>' + buckets[buckets.length - 1];
-}
-export function setFpsInterval(newInterval) {
-    fpsInterval = newInterval;
-}
-export function createFrameCounter(frameTime) {
-    const counter = Object.create(frameCounter);
-    counter.start = frameTime;
-    counter.end = frameTime + fpsInterval;
-    //fill frames with 0 for each bucket
-    for (let i = 0; i < buckets.length; i++) {
-        const bucket = buckets[i];
-        counter.frames[bucket] = 0;
-    }
-    counter.frames[overflowBucketLabel] = 0;
-    return counter;
-}
-//# sourceMappingURL=fps.js.map

package/dist/src/core/lib/fps.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fps.js","sourceRoot":"","sources":["../../../../src/core/lib/fps.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAgBH,IAAI,OAAO,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;AACpC,IAAI,mBAAmB,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC5D,IAAI,WAAW,GAAG,IAAI,CAAC,CAAC,WAAW;AAEnC,MAAM,YAAY,GAAkB;IAClC,KAAK,EAAE,CAAC;IACR,GAAG,EAAE,CAAC;IACN,UAAU,EAAE,CAAC;IACb,MAAM,EAAE,EAAE;IACV,SAAS,CAAC,UAAkB;QAC1B,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAW,CAAC;YACpC,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;gBACzB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAE,EAAE,CAAC;gBACvB,OAAO;YACT,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAE,EAAE,CAAC;IACtC,CAAC;IACD,IAAI,UAAU;QACZ,qDAAqD;QACrD,OAAO,IAAI,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAC1D,CAAC;CACF,CAAC;AAEF,MAAM,UAAU,eAAe,CAAC,UAAoB;IAClD,OAAO,GAAG,UAAU,CAAC;IACrB,mBAAmB,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,WAAmB;IAChD,WAAW,GAAG,WAAW,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,SAAiB;IAClD,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAiB,CAAC;IAC5D,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;IAC1B,OAAO,CAAC,GAAG,GAAG,SAAS,GAAG,WAAW,CAAC;IACtC,oCAAoC;IACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAW,CAAC;QACpC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACxC,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/src/core/text-rendering/TextGenerator.d.ts

@@ -1,10 +0,0 @@
-import type { Stage } from "../Stage";
-import type { FontLoadOptions, TextRenderer, TextRenderers } from "./TextRenderer";
-export default class TextGenerator {
-    readonly stage: Stage;
-    private layoutCache;
-    fontEngines: Record<string, TextRenderer>;
-    constructor(stage: Stage, fontEngines: TextRenderer[]);
-    loadFont(rendererType: TextRenderers, options: FontLoadOptions): any;
-    destroy(): void;
-}

package/dist/src/core/text-rendering/TextGenerator.js

@@ -1,36 +0,0 @@
-export default class TextGenerator {
-    stage;
-    layoutCache = new Map();
-    fontEngines = {};
-    constructor(stage, fontEngines) {
-        this.stage = stage;
-        if (stage.renderer.mode === 'canvas') {
-            //filter out SDF renderer if the main renderer is canvas, since SDF rendering is not supported in that case
-            fontEngines = fontEngines.filter(engine => {
-                if (engine.type === 'canvas') {
-                    return true;
-                }
-                console.warn(`SDF text rendering is not supported in canvas mode. The SDF text renderer will be ignored.`);
-                return false;
-            });
-        }
-        for (let i = 0; i < fontEngines.length; i++) {
-            const engine = fontEngines[i];
-            this.fontEngines[engine.type] = engine;
-            engine.init(stage);
-        }
-    }
-    loadFont(rendererType, options) {
-        const rendererTypeKey = String(rendererType);
-        const fontEngine = this.fontEngines[rendererTypeKey];
-        if (fontEngine === undefined) {
-            throw new Error(`Font handler for renderer type '${rendererTypeKey}' not found. Available types: ${Object.keys(this.fontEngines).join(', ')}`);
-        }
-        return fontEngine.font.loadFont(this.stage, options);
-    }
-    destroy() {
-        // Clean up resources if necessary
-        this.layoutCache.clear();
-    }
-}
-//# sourceMappingURL=TextGenerator.js.map

package/dist/src/core/text-rendering/TextGenerator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TextGenerator.js","sourceRoot":"","sources":["../../../../src/core/text-rendering/TextGenerator.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,OAAO,aAAa;IAKX;IAJb,WAAW,GAA4B,IAAI,GAAG,EAAE,CAAC;IAEzD,WAAW,GAAiC,EAAE,CAAC;IAE/C,YAAqB,KAAY,EAAE,WAA2B;QAAzC,UAAK,GAAL,KAAK,CAAO;QAC/B,IAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpC,2GAA2G;YAC3G,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;gBACxC,IAAG,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC5B,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,4FAA4F,CAAC,CAAC;gBAC3G,OAAO,KAAK,CAAC;YACf,CAAC,CAAC,CAAC;QACL,CAAC;QAED,KAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAE,CAAC;YAC/B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAGD,QAAQ,CAAC,YAA2B,EAAE,OAAwB;QAC5D,MAAM,eAAe,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;QAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAErD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,mCAAmC,eAAe,iCAAiC,MAAM,CAAC,IAAI,CAC5F,IAAI,CAAC,WAAW,CACjB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;QACJ,CAAC;QAED,OAAO,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,OAAO;QAEL,kCAAkC;QAClC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;CACF"}