@lightningjs/renderer 3.0.0-beta2 → 3.0.0-beta20

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, type TextureCoords, type TextureLoadedEventHandler } 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';
@@ -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,23 +46,15 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `clippingRect`
      */
-    Clipping = 16,
+    Clipping = 8,
     /**
-     * Calculated ZIndex update
-     *
-     * @remarks
-     * CoreNode Properties Updated:
-     * - `calcZIndex`
-     */
-    CalculatedZIndex = 32,
-    /**
-     * Z-Index Sorted Children update
+     * Sort Z-Index Children update
      *
      * @remarks
      * CoreNode Properties Updated:
      * - `children` (sorts children by their `calcZIndex`)
      */
-    ZIndexSortedChildren = 64,
+    SortZIndexChildren = 16,
     /**
      * Premultiplied Colors update
      *
@@ -81,7 +65,7 @@ export declare enum UpdateType {
      * - `premultipliedColorBl`
      * - `premultipliedColorBr`
      */
-    PremultipliedColors = 128,
+    PremultipliedColors = 32,
     /**
      * World Alpha update
      *
@@ -89,7 +73,7 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `worldAlpha` = `parent.worldAlpha` * `alpha`
      */
-    WorldAlpha = 256,
+    WorldAlpha = 64,
     /**
      * Render State update
      *
@@ -97,7 +81,7 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `renderState`
      */
-    RenderState = 512,
+    RenderState = 128,
     /**
      * Is Renderable update
      *
@@ -105,19 +89,23 @@ export declare enum UpdateType {
      * CoreNode Properties Updated:
      * - `isRenderable`
      */
-    IsRenderable = 1024,
+    IsRenderable = 256,
     /**
      * Render Texture update
      */
-    RenderTexture = 2048,
+    RenderTexture = 512,
     /**
      * Track if parent has render texture
      */
-    ParentRenderTexture = 4096,
+    ParentRenderTexture = 1024,
     /**
      * Render Bounds update
      */
-    RenderBounds = 8192,
+    RenderBounds = 2048,
+    /**
+     * RecalcUniforms
+     */
+    RecalcUniforms = 4096,
     /**
      * None
      */
@@ -125,11 +113,7 @@ export declare enum UpdateType {
     /**
      * All
      */
-    All = 14335,
-    /**
-     * RecalcUniforms
-     */
-    RecalcUniforms = 16384
+    All = 7167
 }
 /**
  * A custom data map which can be stored on an CoreNode
@@ -168,16 +152,18 @@ export interface CoreNodeProps {
     y: number;
     /**
      * The width of the Node.
+     * @warning This will be deprecated in favor of `w` and `h` properties in the future.
      *
      * @default `0`
      */
-    width: number;
+    w: number;
     /**
      * The height of the Node.
+     * @warning This will be deprecated in favor of `w` and `h` properties in the future.
      *
      * @default `0`
      */
-    height: number;
+    h: number;
     /**
      * The alpha opacity of the Node.
      *
@@ -324,7 +310,11 @@ export interface CoreNodeProps {
      * The Node's z-index.
      *
      * @remarks
-     * TBD
+     * Max z-index of children under the same parent determines which child
+     * is rendered on top. Higher z-index means the Node is rendered on top of
+     * children with lower z-index.
+     *
+     * Max value is 1000 and min value is -1000. Values outside of this range will be clamped.
      */
     zIndex: number;
     /**
@@ -351,15 +341,6 @@ export interface CoreNodeProps {
      * {@link TextRenderer} and should not be set explicitly.
      */
     texture: Texture | null;
-    /**
-     * [Deprecated]: Prevents the texture from being cleaned up when the Node is removed
-     *
-     * @remarks
-     * Please use the `preventCleanup` property on {@link TextureOptions} instead.
-     *
-     * @default false
-     */
-    preventCleanup: boolean;
     /**
      * Options to associate with the Node's Texture
      */
@@ -388,7 +369,6 @@ export interface CoreNodeProps {
      * settings being defaults)
      */
     src: string | null;
-    zIndexLocked: number;
     /**
      * Scale to render the Node at
      *
@@ -605,20 +585,11 @@ export interface CoreNodeProps {
      */
     srcY?: number;
     /**
-     * By enabling Strict bounds the renderer will not process & render child nodes of a node that is out of the visible area
-     *
-     * @remarks
-     * When enabled out of bound nodes, i.e. nodes that are out of the visible area, will
-     * **NOT** have their children processed and renderer anymore. This means the children of a out of bound
-     * node will not receive update processing such as positioning updates and will not be drawn on screen.
-     * As such the rest of the branch of the update tree that sits below this node will not be processed anymore
-     *
-     * 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
-     *
+     * Mark the node as interactive so we can perform hit tests on it
+     * when pointer events are registered.
      * @default false
      */
-    strictBounds: boolean;
+    interactive?: boolean;
 }
 /**
  * Grab all the number properties of type T
@@ -649,10 +620,15 @@ export declare class CoreNode extends EventEmitter {
     protected _id: number;
     readonly props: CoreNodeProps;
     private hasShaderUpdater;
+    hasShaderTimeFn: boolean;
+    private hasColorProps;
+    private zIndexMin;
+    private zIndexMax;
+    previousZIndex: number;
+    zIndexSortList: CoreNode[];
     updateType: UpdateType;
     childUpdateType: UpdateType;
     globalTransform?: Matrix3d;
-    scaleRotateTransform?: Matrix3d;
     localTransform?: Matrix3d;
     sceneGlobalTransform?: Matrix3d;
     renderCoords?: RenderCoords;
@@ -661,6 +637,8 @@ export declare class CoreNode extends EventEmitter {
     strictBound?: Bound;
     preloadBound?: Bound;
     clippingRect: RectWithValid;
+    textureCoords?: TextureCoords;
+    updateShaderUniforms: boolean;
     isRenderable: boolean;
     renderState: CoreNodeRenderState;
     worldAlpha: number;
@@ -672,11 +650,22 @@ export declare class CoreNode extends EventEmitter {
     hasRTTupdates: boolean;
     parentHasRenderTexture: boolean;
     rttParent: CoreNode | null;
+    /**
+     * only used when rtt = true
+     */
+    framebufferDimensions: Dimensions | null;
+    destroyed: boolean;
     constructor(stage: Stage, props: CoreNodeProps);
     loadTexture(): void;
+    /**
+     * Task for queueMicrotask to loadTexture
+     *
+     * @remarks
+     * This method is called in a microtask to release the texture.
+     */
+    private loadTextureTask;
     unloadTexture(): void;
-    autosizeNode(dimensions: Dimensions): void;
-    private onTextureLoaded;
+    protected onTextureLoaded: TextureLoadedEventHandler;
     private onTextureFailed;
     private onTextureFreed;
     /**
@@ -688,8 +677,6 @@ export declare class CoreNode extends EventEmitter {
      * @param type
      */
     setUpdateType(type: UpdateType): void;
-    sortChildren(): void;
-    updateScaleRotateTransform(): void;
     updateLocalTransform(): void;
     /**
      * @todo: test for correct calculation flag
@@ -697,21 +684,20 @@ export declare class CoreNode extends EventEmitter {
      */
     update(delta: number, parentClippingRect: RectWithValid): void;
     private findParentRTTNode;
-    private getRTTParentRenderState;
     private notifyChildrenRTTOfUpdate;
-    private notifyParentRTTOfUpdate;
+    protected notifyParentRTTOfUpdate(): void;
     checkRenderBounds(): CoreNodeRenderState;
     updateBoundingRect(): void;
     createRenderBounds(): void;
     updateRenderState(renderState: CoreNodeRenderState): void;
-    /**
-     * 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;
+    /**
+     * Updates the `isRenderable` property based on various conditions.
+     */
+    updateIsRenderable(): void;
     /**
      * Sets the renderable state and triggers changes if necessary.
      * @param isRenderable - The new renderable state
@@ -729,11 +715,6 @@ export declare class CoreNode extends EventEmitter {
      * 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.
@@ -744,12 +725,15 @@ export declare class CoreNode extends EventEmitter {
      * Finally, the node's parentClippingRect and clippingRect properties are updated.
      */
     calculateClippingRect(parentClippingRect: RectWithValid): void;
-    calculateZIndex(): void;
     /**
      * Destroy the node and cleanup all resources
      */
     destroy(): void;
     renderQuads(renderer: CoreRenderer): void;
+    getTimerValue(): number;
+    sortChildren(): void;
+    removeChild(node: CoreNode, targetParent?: CoreNode | null): void;
+    addChild(node: CoreNode, previousParent?: CoreNode | null): void;
     get id(): number;
     get data(): CustomDataMap | undefined;
     set data(d: CustomDataMap | undefined);
@@ -759,10 +743,10 @@ export declare class CoreNode extends EventEmitter {
     get absY(): number;
     get y(): number;
     set y(value: number);
-    get width(): number;
-    set width(value: number);
-    get height(): number;
-    set height(value: number);
+    get w(): number;
+    set w(value: number);
+    get h(): number;
+    set h(value: number);
     get scale(): number;
     set scale(value: number);
     get scaleX(): number;
@@ -809,14 +793,10 @@ export declare class CoreNode extends EventEmitter {
     set colorBl(value: number);
     get colorBr(): number;
     set colorBr(value: number);
-    get zIndexLocked(): number;
-    set zIndexLocked(value: number);
     get zIndex(): number;
     set zIndex(value: number);
     get parent(): CoreNode | null;
     set parent(newParent: CoreNode | null);
-    get preventCleanup(): boolean;
-    set preventCleanup(value: boolean);
     get rtt(): boolean;
     set rtt(value: boolean);
     private initRenderTexture;
@@ -839,12 +819,9 @@ export declare class CoreNode extends EventEmitter {
     get srcY(): number | undefined;
     set srcY(value: number);
     /**
-     * Returns the framebuffer dimensions of the node.
-     * If the node has a render texture, the dimensions are the same as the node's dimensions.
-     * If the node does not have a render texture, the dimensions are inherited from the parent.
-     * If the node parent has a render texture and the node is a render texture, the nodes dimensions are used.
+     * Returns the framebuffer dimensions of the RTT parent
      */
-    get framebufferDimensions(): Dimensions;
+    get parentFramebufferDimensions(): Dimensions;
     /**
      * Returns the parent render texture node if it exists.
      */
@@ -853,8 +830,9 @@ export declare class CoreNode extends EventEmitter {
     set texture(value: Texture | null);
     set textureOptions(value: TextureOptions);
     get textureOptions(): TextureOptions;
-    get strictBounds(): boolean;
-    set strictBounds(v: boolean);
+    set interactive(value: boolean | undefined);
+    get interactive(): boolean | undefined;
+    setRTTUpdates(type: number): void;
     animate(props: Partial<CoreNodeAnimateProps>, settings: Partial<AnimationSettings>): IAnimationController;
     flush(): void;
 }