@lightningjs/renderer 3.0.0-beta6 → 3.0.0-beta8

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/exports/utils.d.ts

@@ -21,6 +21,7 @@
  *
  * @module Utils
  */
-export { assertTruthy, mergeColorAlpha, deg2Rad } from '../src/utils.js';
+export { assertTruthy, mergeColorAlpha, deg2Rad, mergeColorProgress, } from '../src/utils.js';
 export { getNormalizedRgbaComponents } from '../src/core/lib/utils.js';
+export { getTimingFunction } from '../src/core/utils.js';
 export { EventEmitter } from '../src/common/EventEmitter.js';

package/dist/exports/utils.js

@@ -39,7 +39,8 @@
  *
  * @module Utils
  */
-export { assertTruthy, mergeColorAlpha, deg2Rad } from '../src/utils.js';
+export { assertTruthy, mergeColorAlpha, deg2Rad, mergeColorProgress, } from '../src/utils.js';
 export { getNormalizedRgbaComponents } from '../src/core/lib/utils.js';
+export { getTimingFunction } from '../src/core/utils.js';
 export { EventEmitter } from '../src/common/EventEmitter.js';
 //# sourceMappingURL=utils.js.map

package/dist/exports/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../exports/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../exports/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,EACL,YAAY,EACZ,eAAe,EACf,OAAO,EACP,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC"}

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

@@ -22,31 +22,23 @@ export declare enum UpdateType {
      */
     Children = 1,
     /**
-     * Scale/Rotate transform update
-     *
-     * @remarks
-     * CoreNode Properties Updated:
-     * - `scaleRotateTransform`
-     */
-    ScaleRotate = 2,
-    /**
-     * Translate transform update (x/y/width/height/pivot/mount)
+     * localTransform
      *
      * @remarks
      * CoreNode Properties Updated:
      * - `localTransform`
      */
-    Local = 4,
+    Local = 2,
     /**
-     * Global Transform update
+     * globalTransform
      *
-     * @remarks
+     * * @remarks
      * CoreNode Properties Updated:
      * - `globalTransform`
+     * - `renderBounds`
      * - `renderCoords`
-     * - `renderBound`
      */
-    Global = 8,
+    Global = 4,
     /**
      * Clipping rect update
      *
@@ -54,7 +46,7 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `clippingRect`
      */
-    Clipping = 16,
+    Clipping = 8,
     /**
      * Calculated ZIndex update
      *
@@ -62,7 +54,7 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `calcZIndex`
      */
-    CalculatedZIndex = 32,
+    CalculatedZIndex = 16,
     /**
      * Z-Index Sorted Children update
      *
@@ -70,7 +62,7 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `children` (sorts children by their `calcZIndex`)
      */
-    ZIndexSortedChildren = 64,
+    ZIndexSortedChildren = 32,
     /**
      * Premultiplied Colors update
      *
@@ -81,7 +73,7 @@ export declare enum UpdateType {
      * - `premultipliedColorBl`
      * - `premultipliedColorBr`
      */
-    PremultipliedColors = 128,
+    PremultipliedColors = 64,
     /**
      * World Alpha update
      *
@@ -89,7 +81,7 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `worldAlpha` = `parent.worldAlpha` * `alpha`
      */
-    WorldAlpha = 256,
+    WorldAlpha = 128,
     /**
      * Render State update
      *
@@ -97,7 +89,7 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `renderState`
      */
-    RenderState = 512,
+    RenderState = 256,
     /**
      * Is Renderable update
      *
@@ -105,19 +97,23 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `isRenderable`
      */
-    IsRenderable = 1024,
+    IsRenderable = 512,
     /**
      * Render Texture update
      */
-    RenderTexture = 2048,
+    RenderTexture = 1024,
     /**
      * Track if parent has render texture
      */
-    ParentRenderTexture = 4096,
+    ParentRenderTexture = 2048,
     /**
      * Render Bounds update
      */
-    RenderBounds = 8192,
+    RenderBounds = 4096,
+    /**
+     * RecalcUniforms
+     */
+    RecalcUniforms = 8192,
     /**
      * None
      */
@@ -125,11 +121,7 @@ export declare enum UpdateType {
     /**
      * All
      */
-    All = 14335,
-    /**
-     * RecalcUniforms
-     */
-    RecalcUniforms = 16384
+    All = 16383
 }
 /**
  * A custom data map which can be stored on an CoreNode
@@ -595,6 +587,12 @@ export interface CoreNodeProps {
      * are provided. Only works when createImageBitmap is supported on the browser.
      */
     srcY?: number;
+    /**
+     * Mark the node as interactive so we can perform hit tests on it
+     * when pointer events are registered.
+     * @default false
+     */
+    interactive?: boolean;
     /**
      * By enabling Strict bounds the renderer will not process & render child nodes of a node that is out of the visible area
      *
@@ -607,7 +605,7 @@ export interface CoreNodeProps {
      * This is a big performance gain but may be disabled in cases where the width of the parent node is
      * unknown and the render must process the child nodes regardless of the viewport status of the parent node
      *
-     * @default false
+     * @default true
      */
     strictBounds: boolean;
 }
@@ -640,10 +638,10 @@ export declare class CoreNode extends EventEmitter {
     protected _id: number;
     readonly props: CoreNodeProps;
     private hasShaderUpdater;
+    private hasColorProps;
     updateType: UpdateType;
     childUpdateType: UpdateType;
     globalTransform?: Matrix3d;
-    scaleRotateTransform?: Matrix3d;
     localTransform?: Matrix3d;
     sceneGlobalTransform?: Matrix3d;
     renderCoords?: RenderCoords;
@@ -669,6 +667,7 @@ export declare class CoreNode extends EventEmitter {
      * only used when rtt = true
      */
     framebufferDimensions: Dimensions | null;
+    destroyed: boolean;
     constructor(stage: Stage, props: CoreNodeProps);
     loadTexture(): void;
     unloadTexture(): void;
@@ -686,7 +685,6 @@ export declare class CoreNode extends EventEmitter {
      */
     setUpdateType(type: UpdateType): void;
     sortChildren(): void;
-    updateScaleRotateTransform(): void;
     updateLocalTransform(): void;
     /**
      * @todo: test for correct calculation flag
@@ -704,10 +702,6 @@ export declare class CoreNode extends EventEmitter {
      * Updates the `isRenderable` property based on various conditions.
      */
     updateIsRenderable(): void;
-    /**
-     * Checks if the node is renderable based on world alpha, dimensions and out of bounds status.
-     */
-    checkBasicRenderability(): boolean;
     /**
      * Sets the renderable state and triggers changes if necessary.
      * @param isRenderable - The new renderable state
@@ -717,19 +711,6 @@ export declare class CoreNode extends EventEmitter {
      * Changes the renderable state of the node.
      */
     updateTextureOwnership(isRenderable: boolean): void;
-    /**
-     * Checks if the node is out of the viewport bounds.
-     */
-    isOutOfBounds(): boolean;
-    /**
-     * Checks if the node has dimensions (width/height)
-     */
-    hasDimensions(): boolean;
-    /**
-     * Checks if the node has any color properties set.
-     */
-    hasColorProperties(): boolean;
-    hasShader(): boolean;
     calculateRenderCoords(): void;
     /**
      * This function calculates the clipping rectangle for a node.
@@ -844,6 +825,9 @@ export declare class CoreNode extends EventEmitter {
     set texture(value: Texture | null);
     set textureOptions(value: TextureOptions);
     get textureOptions(): TextureOptions;
+    set interactive(value: boolean | undefined);
+    get interactive(): boolean | undefined;
+    setRTTUpdates(type: number): void;
     get strictBounds(): boolean;
     set strictBounds(v: boolean);
     animate(props: Partial<CoreNodeAnimateProps>, settings: Partial<AnimationSettings>): IAnimationController;