@lightningjs/renderer 3.0.0-beta1 → 3.0.0-beta10

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,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 = 14335
 }
 /**
  * A custom data map which can be stored on an CoreNode
@@ -351,15 +343,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
      */
@@ -604,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
      *
@@ -616,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;
 }
@@ -648,10 +637,11 @@ export declare class CoreNode extends EventEmitter {
     readonly children: CoreNode[];
     protected _id: number;
     readonly props: CoreNodeProps;
+    private hasShaderUpdater;
+    private hasColorProps;
     updateType: UpdateType;
     childUpdateType: UpdateType;
     globalTransform?: Matrix3d;
-    scaleRotateTransform?: Matrix3d;
     localTransform?: Matrix3d;
     sceneGlobalTransform?: Matrix3d;
     renderCoords?: RenderCoords;
@@ -660,6 +650,8 @@ export declare class CoreNode extends EventEmitter {
     strictBound?: Bound;
     preloadBound?: Bound;
     clippingRect: RectWithValid;
+    textureCoords?: TextureCoords;
+    updateTextureCoords?: boolean;
     isRenderable: boolean;
     renderState: CoreNodeRenderState;
     worldAlpha: number;
@@ -671,11 +663,16 @@ 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;
     unloadTexture(): void;
     autosizeNode(dimensions: Dimensions): void;
-    private onTextureLoaded;
+    protected onTextureLoaded: TextureLoadedEventHandler;
     private onTextureFailed;
     private onTextureFreed;
     /**
@@ -688,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
@@ -696,9 +692,8 @@ 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;
@@ -707,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
@@ -720,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.
@@ -814,8 +792,6 @@ export declare class CoreNode extends EventEmitter {
     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;
@@ -838,12 +814,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.
      */
@@ -852,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;