@lightningjs/renderer 2.9.0-beta1 → 2.9.0-beta3

package/README.md

@@ -1,147 +1,147 @@
-# Lightning 3 Renderer
-
-A powerful 2D scene renderer designed for rendering highly performant user
-interfaces on web browsers running on embedded devices using WebGL.
-
-The Renderer is part of the [LightningJS](https://lightningjs.io) project. While it is possible to use the renderer directly, it is not recommended. Instead, Lightning 3 works best when combined with [Blits](https://lightningjs.io/v3-docs/blits/getting_started/intro.html).
-
-## Setup & Commands
-
-```
-# Install renderer + example dependencies
-pnpm install
-
-# Build Renderer
-pnpm build
-
-# Build Renderer (watch mode)
-pnpm watch
-
-# Run unit tests
-pnpm test
-
-# Run Visual Regression Tests
-pnpm test:visual
-
-# Build API Documentation (builds into ./typedocs folder)
-pnpm typedoc
-
-# Launch Example Tests in dev mode (includes Build Renderer (watch mode))
-pnpm start
-
-# Launch Example Tests in production mode
-# IMPORTANT: To run test examples on embedded devices that use older browser versions
-# you MUST run the examples in this mode.
-pnpm start:prod
-```
-
-## Browser Targets
-
-The Lightning 3 Renderer's goal is to work with the following browser versions and above:
-
-- Chrome v38 (Released October 7, 2014)
-
-Any JavaScript language features or browser APIs that cannot be automatically transpiled or polyfilled by industry standard transpilers (such as Babel) to target these versions must be carefully considered before use.
-
-For a more detailed and comprehensive list of browsers and their features please see [browsers](./BROWSERS.md).
-
-## Example Tests
-
-The Example Tests sub-project define a set of tests for various Renderer
-features. This is NOT an automated test. The command below will launch a
-web server which can be accessed by a web browser for manual testing. However,
-many of the Example Tests define Snapshots for the Visual Regression Test Runner
-(see below).
-
-The Example Tests can be launched with:
-
-```
-pnpm start
-```
-
-A hosted version can be found [here](https://lightning-js.github.io/renderer/).
-
-This supports modern browsers as well as Chrome 38 and above through a legacy build.
-
-See [examples/README.md](./examples/README.md) for more info.
-
-## Visual Regression Tests
-
-In order to prevent bugs on existing Renderer features when new features or bug
-fixes are added, the Renderer includes a Visual Regression Test Runner along
-with a set of certified snapshot files that are checked into the repository.
-
-These tests can be launched with:
-
-```
-pnpm test:visual
-```
-
-The captured Snapshots of these tests are optionally defined in the individual
-Example Tests.
-
-See [visual-regression/README.md](./visual-regression/README.md) for more info.
-
-## Manual Regression Tests
-
-See [docs/ManualRegressionTests.md].
-
-## Release Procedure
-
-See [RELEASE.md](./RELEASE.md)
-
-## Installing Fonts
-
-Fonts can be installed into the Font Manager exposed by the Renderer's Stage.
-There are two types of fonts that you can install, Web/Canvas2D fonts (WebTrFontFace)
-and SDF fonts (SdfTrFontFace). Install that fonts that your applications needs
-at start up so they are ready when your application is rendered.
-
-```ts
-import {
-  RendererMain,
-  WebTrFontFace,
-  SdfTrFontFace,
-} from '@lightningjs/renderer';
-
-import {
-  WebGlCoreRenderer,
-  SdfTextRenderer,
-} from '@lightningjs/renderer/webgl';
-import { CanvasTextRenderer } from '@lightningjs/renderer/canvas';
-
-const renderer = new RendererMain(
-  {
-    appWidth: 1920,
-    appHeight: 1080,
-    renderEngine: WebGlCoreRenderer,
-    fontEngines: [SdfTextRenderer, CanvasTextRenderer],
-    // ...Other Renderer Config
-  },
-  'app', // id of div to insert Canvas.
-);
-
-// Load fonts into renderer
-renderer.stage.fontManager.addFontFace(
-  new WebTrFontFace('Ubuntu', {}, '/fonts/Ubuntu-Regular.ttf'),
-);
-
-renderer.stage.fontManager.addFontFace(
-  new SdfTrFontFace(
-    'Ubuntu',
-    {},
-    'msdf',
-    stage,
-    '/fonts/Ubuntu-Regular.msdf.png',
-    '/fonts/Ubuntu-Regular.msdf.json',
-  ),
-);
-```
-
-Please note that the WebGL renderer supports both SDF Fonts and Web Fonts, however the
-Canvas renderer only supports Web Fonts:
-
-| Font Type Renderer | SDF Font | Web Font |
-| ------------------ | -------- | -------- |
-| WebGL              | Y        | Y        |
-| Canvas             | N        | Y        |
+# Lightning 3 Renderer
+
+A powerful 2D scene renderer designed for rendering highly performant user
+interfaces on web browsers running on embedded devices using WebGL.
+
+The Renderer is part of the [LightningJS](https://lightningjs.io) project. While it is possible to use the renderer directly, it is not recommended. Instead, Lightning 3 works best when combined with [Blits](https://lightningjs.io/v3-docs/blits/getting_started/intro.html).
+
+## Setup & Commands
+
+```
+# Install renderer + example dependencies
+pnpm install
+
+# Build Renderer
+pnpm build
+
+# Build Renderer (watch mode)
+pnpm watch
+
+# Run unit tests
+pnpm test
+
+# Run Visual Regression Tests
+pnpm test:visual
+
+# Build API Documentation (builds into ./typedocs folder)
+pnpm typedoc
+
+# Launch Example Tests in dev mode (includes Build Renderer (watch mode))
+pnpm start
+
+# Launch Example Tests in production mode
+# IMPORTANT: To run test examples on embedded devices that use older browser versions
+# you MUST run the examples in this mode.
+pnpm start:prod
+```
+
+## Browser Targets
+
+The Lightning 3 Renderer's goal is to work with the following browser versions and above:
+
+- Chrome v38 (Released October 7, 2014)
+
+Any JavaScript language features or browser APIs that cannot be automatically transpiled or polyfilled by industry standard transpilers (such as Babel) to target these versions must be carefully considered before use.
+
+For a more detailed and comprehensive list of browsers and their features please see [browsers](./BROWSERS.md).
+
+## Example Tests
+
+The Example Tests sub-project define a set of tests for various Renderer
+features. This is NOT an automated test. The command below will launch a
+web server which can be accessed by a web browser for manual testing. However,
+many of the Example Tests define Snapshots for the Visual Regression Test Runner
+(see below).
+
+The Example Tests can be launched with:
+
+```
+pnpm start
+```
+
+A hosted version can be found [here](https://lightning-js.github.io/renderer/).
+
+This supports modern browsers as well as Chrome 38 and above through a legacy build.
+
+See [examples/README.md](./examples/README.md) for more info.
+
+## Visual Regression Tests
+
+In order to prevent bugs on existing Renderer features when new features or bug
+fixes are added, the Renderer includes a Visual Regression Test Runner along
+with a set of certified snapshot files that are checked into the repository.
+
+These tests can be launched with:
+
+```
+pnpm test:visual
+```
+
+The captured Snapshots of these tests are optionally defined in the individual
+Example Tests.
+
+See [visual-regression/README.md](./visual-regression/README.md) for more info.
+
+## Manual Regression Tests
+
+See [docs/ManualRegressionTests.md].
+
+## Release Procedure
+
+See [RELEASE.md](./RELEASE.md)
+
+## Installing Fonts
+
+Fonts can be installed into the Font Manager exposed by the Renderer's Stage.
+There are two types of fonts that you can install, Web/Canvas2D fonts (WebTrFontFace)
+and SDF fonts (SdfTrFontFace). Install that fonts that your applications needs
+at start up so they are ready when your application is rendered.
+
+```ts
+import {
+  RendererMain,
+  WebTrFontFace,
+  SdfTrFontFace,
+} from '@lightningjs/renderer';
+
+import {
+  WebGlCoreRenderer,
+  SdfTextRenderer,
+} from '@lightningjs/renderer/webgl';
+import { CanvasTextRenderer } from '@lightningjs/renderer/canvas';
+
+const renderer = new RendererMain(
+  {
+    appWidth: 1920,
+    appHeight: 1080,
+    renderEngine: WebGlCoreRenderer,
+    fontEngines: [SdfTextRenderer, CanvasTextRenderer],
+    // ...Other Renderer Config
+  },
+  'app', // id of div to insert Canvas.
+);
+
+// Load fonts into renderer
+renderer.stage.fontManager.addFontFace(
+  new WebTrFontFace('Ubuntu', {}, '/fonts/Ubuntu-Regular.ttf'),
+);
+
+renderer.stage.fontManager.addFontFace(
+  new SdfTrFontFace(
+    'Ubuntu',
+    {},
+    'msdf',
+    stage,
+    '/fonts/Ubuntu-Regular.msdf.png',
+    '/fonts/Ubuntu-Regular.msdf.json',
+  ),
+);
+```
+
+Please note that the WebGL renderer supports both SDF Fonts and Web Fonts, however the
+Canvas renderer only supports Web Fonts:
+
+| Font Type Renderer | SDF Font | Web Font |
+| ------------------ | -------- | -------- |
+| WebGL              | Y        | Y        |
+| Canvas             | N        | Y        |

package/dist/src/core/CoreNode.d.ts

@@ -1,7 +1,7 @@
 import type { TextureOptions } from './CoreTextureManager.js';
 import type { CoreRenderer } from './renderers/CoreRenderer.js';
 import type { Stage } from './Stage.js';
-import type { Texture } from './textures/Texture.js';
+import { type Texture } from './textures/Texture.js';
 import type { Dimensions } from '../common/CommonTypes.js';
 import { EventEmitter } from '../common/EventEmitter.js';
 import { type Bound, type RectWithValid } from './lib/utils.js';
@@ -657,6 +657,7 @@ export declare class CoreNode extends EventEmitter {
     rttParent: CoreNode | null;
     constructor(stage: Stage, props: CoreNodeProps);
     loadTexture(): void;
+    createDefaultTexture(): void;
     unloadTexture(): void;
     autosizeNode(dimensions: Dimensions): void;
     private onTextureLoaded;

package/dist/src/core/CoreNode.js

@@ -17,6 +17,7 @@
  * limitations under the License.
  */
 import { assertTruthy, getNewId, mergeColorAlphaPremultiplied, } from '../utils.js';
+import {} from './textures/Texture.js';
 import { EventEmitter } from '../common/EventEmitter.js';
 import { copyRect, intersectRect, createBound, boundInsideBound, boundLargeThanBound, createPreloadBounds, } from './lib/utils.js';
 import { Matrix3d } from './lib/Matrix3d.js';
@@ -206,6 +207,7 @@ export class CoreNode extends EventEmitter {
             UpdateType.Local |
             UpdateType.RenderBounds |
             UpdateType.RenderState);
+        this.createDefaultTexture();
     }
     //#region Textures
     loadTexture() {
@@ -217,10 +219,6 @@ export class CoreNode extends EventEmitter {
         // synchronous task after calling loadTexture()
         queueMicrotask(() => {
             texture.preventCleanup = this.props.preventCleanup;
-            // Preload texture if required
-            if (this.textureOptions.preload) {
-                texture.ctxTexture.load();
-            }
             texture.on('loaded', this.onTextureLoaded);
             texture.on('failed', this.onTextureFailed);
             texture.on('freed', this.onTextureFreed);
@@ -246,6 +244,15 @@ export class CoreNode extends EventEmitter {
             }
         });
     }
+    createDefaultTexture() {
+        // load default texture if no texture is set
+        if (this.stage.defaultTexture !== null &&
+            this.props.src === null &&
+            this.props.texture === null &&
+            this.props.rtt === false) {
+            this.texture = this.stage.defaultTexture;
+        }
+    }
     unloadTexture() {
         if (this.texture !== null) {
             this.texture.off('loaded', this.onTextureLoaded);
@@ -262,6 +269,7 @@ export class CoreNode extends EventEmitter {
     }
     onTextureLoaded = (_, dimensions) => {
         this.autosizeNode(dimensions);
+        this.setUpdateType(UpdateType.IsRenderable);
         // Texture was loaded. In case the RAF loop has already stopped, we request
         // a render to ensure the texture is rendered.
         this.stage.requestRender();
@@ -269,16 +277,20 @@ export class CoreNode extends EventEmitter {
         if (this.parentHasRenderTexture) {
             this.notifyParentRTTOfUpdate();
         }
-        this.emit('loaded', {
-            type: 'texture',
-            dimensions,
-        });
+        // ignore 1x1 pixel textures
+        if (dimensions.width > 1 && dimensions.height > 1) {
+            this.emit('loaded', {
+                type: 'texture',
+                dimensions,
+            });
+        }
         // Trigger a local update if the texture is loaded and the resizeMode is 'contain'
         if (this.props.textureOptions?.resizeMode?.type === 'contain') {
             this.setUpdateType(UpdateType.Local);
         }
     };
     onTextureFailed = (_, error) => {
+        this.setUpdateType(UpdateType.IsRenderable);
         // If parent has a render texture, flag that we need to update
         if (this.parentHasRenderTexture) {
             this.notifyParentRTTOfUpdate();
@@ -289,6 +301,7 @@ export class CoreNode extends EventEmitter {
         });
     };
     onTextureFreed = () => {
+        this.setUpdateType(UpdateType.IsRenderable);
         // If parent has a render texture, flag that we need to update
         if (this.parentHasRenderTexture) {
             this.notifyParentRTTOfUpdate();
@@ -549,8 +562,11 @@ export class CoreNode extends EventEmitter {
     }
     //check if CoreNode is renderable based on props
     hasRenderableProperties() {
-        if (this.props.texture) {
-            return true;
+        if (this.texture !== null) {
+            if (this.texture.state === 'loaded') {
+                return true;
+            }
+            return false;
         }
         if (!this.props.width || !this.props.height) {
             return false;
@@ -558,7 +574,7 @@ export class CoreNode extends EventEmitter {
         if (this.props.shader !== this.stage.defShaderCtr) {
             return true;
         }
-        if (this.props.clipping) {
+        if (this.props.clipping === true) {
             return true;
         }
         if (this.props.color !== 0) {
@@ -566,28 +582,14 @@ export class CoreNode extends EventEmitter {
         }
         // Consider removing these checks and just using the color property check above.
         // Maybe add a forceRender prop for nodes that should always render.
-        if (this.props.colorTop !== 0) {
-            return true;
-        }
-        if (this.props.colorBottom !== 0) {
-            return true;
-        }
-        if (this.props.colorLeft !== 0) {
-            return true;
-        }
-        if (this.props.colorRight !== 0) {
-            return true;
-        }
-        if (this.props.colorTl !== 0) {
-            return true;
-        }
-        if (this.props.colorTr !== 0) {
-            return true;
-        }
-        if (this.props.colorBl !== 0) {
-            return true;
-        }
-        if (this.props.colorBr !== 0) {
+        if (this.props.colorTop !== 0 ||
+            this.props.colorBottom !== 0 ||
+            this.props.colorLeft !== 0 ||
+            this.props.colorRight !== 0 ||
+            this.props.colorTl !== 0 ||
+            this.props.colorTr !== 0 ||
+            this.props.colorBl !== 0 ||
+            this.props.colorBr !== 0) {
             return true;
         }
         return false;
@@ -691,6 +693,13 @@ export class CoreNode extends EventEmitter {
         else {
             newIsRenderable = this.renderState > CoreNodeRenderState.OutOfBounds;
         }
+        // If the texture is not loaded and the node is renderable, load the texture
+        // this only needs to happen once or until the texture is no longer loaded
+        if (this.texture !== null &&
+            this.texture.state === 'freed' &&
+            this.renderState > CoreNodeRenderState.OutOfBounds) {
+            this.stage.txManager.loadTexture(this.texture);
+        }
         if (this.isRenderable !== newIsRenderable) {
             this.isRenderable = newIsRenderable;
             this.onChangeIsRenderable(newIsRenderable);
@@ -813,6 +822,7 @@ export class CoreNode extends EventEmitter {
         }
         assertTruthy(this.globalTransform);
         assertTruthy(this.renderCoords);
+        assertTruthy(this.texture);
         // add to list of renderables to be sorted before rendering
         renderer.addQuad({
             width: this.props.width,
@@ -886,11 +896,10 @@ export class CoreNode extends EventEmitter {
             this.props.width = value;
             this.setUpdateType(UpdateType.Local);
             if (this.props.rtt) {
-                this.texture = this.stage.txManager.loadTexture('RenderTexture', {
+                this.texture = this.stage.txManager.createTexture('RenderTexture', {
                     width: this.width,
                     height: this.height,
                 });
-                this.textureOptions.preload = true;
                 this.setUpdateType(UpdateType.RenderTexture);
             }
         }
@@ -903,11 +912,10 @@ export class CoreNode extends EventEmitter {
             this.props.height = value;
             this.setUpdateType(UpdateType.Local);
             if (this.props.rtt) {
-                this.texture = this.stage.txManager.loadTexture('RenderTexture', {
+                this.texture = this.stage.txManager.createTexture('RenderTexture', {
                     width: this.width,
                     height: this.height,
                 });
-                this.textureOptions.preload = true;
                 this.setUpdateType(UpdateType.RenderTexture);
             }
         }
@@ -1195,11 +1203,12 @@ export class CoreNode extends EventEmitter {
         }
     }
     initRenderTexture() {
-        this.texture = this.stage.txManager.loadTexture('RenderTexture', {
+        this.texture = this.stage.txManager.createTexture('RenderTexture', {
             width: this.width,
             height: this.height,
         });
-        this.textureOptions.preload = true;
+        // call load immediately to ensure the texture is created
+        this.stage.txManager.loadTexture(this.texture, true);
         this.stage.renderer?.renderToTexture(this); // Only this RTT node
     }
     cleanupRenderTexture() {
@@ -1263,7 +1272,7 @@ export class CoreNode extends EventEmitter {
             this.texture = null;
             return;
         }
-        this.texture = this.stage.txManager.loadTexture('ImageTexture', {
+        this.texture = this.stage.txManager.createTexture('ImageTexture', {
             src: imageUrl,
             width: this.props.width,
             height: this.props.height,
@@ -1345,10 +1354,14 @@ export class CoreNode extends EventEmitter {
             this.unloadTexture();
         }
         this.props.texture = value;
-        if (value) {
+        if (value !== null) {
             value.setRenderableOwner(this, this.isRenderable);
             this.loadTexture();
         }
+        else {
+            // If the texture is null, create a default texture
+            this.createDefaultTexture();
+        }
         this.setUpdateType(UpdateType.IsRenderable);
     }
     set textureOptions(value) {
@@ -1370,9 +1383,7 @@ export class CoreNode extends EventEmitter {
     }
     animate(props, settings) {
         const animation = new CoreAnimation(this, props, settings);
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
         const controller = new CoreAnimationController(this.stage.animationManager, animation);
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return controller;
     }
     flush() {