@lightningjs/renderer 0.6.0 → 0.7.0

package/README.md

@@ -28,7 +28,7 @@ pnpm test
 # Run Visual Regression Tests
 pnpm test:visual
 
-# Build API Documentation (builds into ./docs folder)
+# Build API Documentation (builds into ./typedocs folder)
 pnpm typedoc
 
 # Launch Example Tests in dev mode (includes Build Renderer (watch mode))

package/dist/src/common/CommonTypes.d.ts

@@ -56,3 +56,11 @@ export type NodeLoadedEventHandler = (target: any, payload: NodeLoadedPayload) =
  * Event handler for when the texture/text of a node has failed to load
  */
 export type NodeFailedEventHandler = (target: any, payload: NodeFailedPayload) => void;
+/**
+ * Event payload for when an FpsUpdate event is emitted by either the Stage or
+ * MainRenderer
+ */
+export interface FpsUpdatePayload {
+    fps: number;
+    contextSpyData: Record<string, number> | null;
+}

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

@@ -42,17 +42,72 @@ export interface CoreNodeProps {
     rotation: number;
 }
 type ICoreNode = Omit<CoreNodeProps, 'texture' | 'textureOptions' | 'shader' | 'shaderProps'>;
+declare enum UpdateType {
+    /**
+     * Child updates
+     */
+    Children = 1,
+    /**
+     * Scale/Rotate transform update
+     */
+    ScaleRotate = 2,
+    /**
+     * Translate transform update (x/y/width/height/pivot/mount)
+     */
+    Local = 4,
+    /**
+     * Global transform update
+     */
+    Global = 8,
+    /**
+     * Clipping rect update
+     */
+    Clipping = 16,
+    /**
+     * Calculated ZIndex update
+     */
+    CalculatedZIndex = 32,
+    /**
+     * Z-Index Sorted Children update
+     */
+    ZIndexSortedChildren = 64,
+    /**
+     * Premultiplied Colors
+     */
+    PremultipliedColors = 128,
+    /**
+     * World Alpha
+     *
+     * @remarks
+     * World Alpha = Parent World Alpha * Alpha
+     */
+    WorldAlpha = 256,
+    /**
+     * None
+     */
+    None = 0,
+    /**
+     * All
+     */
+    All = 511
+}
 export declare class CoreNode extends EventEmitter implements ICoreNode {
     protected stage: Stage;
     readonly children: CoreNode[];
     protected props: Required<CoreNodeProps>;
-    recalculationType: number;
-    hasUpdates: boolean;
+    updateType: UpdateType;
     globalTransform?: Matrix3d;
     scaleRotateTransform?: Matrix3d;
     localTransform?: Matrix3d;
     clippingRect: Rect | null;
+    isRenderable: boolean;
     private parentClippingRect;
+    worldAlpha: number;
+    premultipliedColorTl: number;
+    premultipliedColorTr: number;
+    premultipliedColorBl: number;
+    premultipliedColorBr: number;
+    calcZIndex: number;
     private isComplex;
     constructor(stage: Stage, props: CoreNodeProps);
     loadTexture<Type extends keyof TextureMap>(textureType: Type, props: ExtractProps<TextureMap[Type]>, options?: TextureOptions | null): void;
@@ -60,19 +115,15 @@ export declare class CoreNode extends EventEmitter implements ICoreNode {
     private onTextureLoaded;
     private onTextureFailed;
     loadShader<Type extends keyof ShaderMap>(shaderType: Type, props: ExtractProps<ShaderMap[Type]>): void;
-    setHasUpdates(): void;
-    setChildrenHasUpdates(): void;
-    setParentHasUpdates(): void;
     /**
      * Change types types is used to determine the scope of the changes being applied
-     * 1 - alpha recalculation
-     * 2 - translate recalculation
-     * 4 - transform recalculation
-     * 8 - z-index recalculation
+     *
+     * @remarks
+     * See {@link UpdateType} for more information on each type
      *
      * @param type
      */
-    setRecalculationType(type: number): void;
+    setUpdateType(type: UpdateType): void;
     sortChildren(): void;
     updateScaleRotateTransform(): void;
     updateLocalTransform(): void;
@@ -81,11 +132,10 @@ export declare class CoreNode extends EventEmitter implements ICoreNode {
      * @param delta
      */
     update(delta: number, parentClippingRect?: Rect | null): void;
+    checkIsRenderable(): boolean;
     /**
      * This function calculates the clipping rectangle for a node.
      *
-     * If the node's globalTransform is not set, the function returns immediately.
-     * If the node's props do not require clipping and there is no parent clipping rectangle, the node's clipping rectangle is set to null.
      * If the parent clipping rectangle has not changed and the node's clipping rectangle is already set, the function returns immediately.
      *
      * The function then checks if the node is rotated. If the node requires clipping and is not rotated, a new clipping rectangle is created based on the node's global transform and dimensions.
@@ -94,6 +144,7 @@ export declare class CoreNode extends EventEmitter implements ICoreNode {
      * Finally, the node's parentClippingRect and clippingRect properties are updated.
      */
     calculateClippingRect(parentClippingRect?: Rect | null): void;
+    calculateZIndex(): void;
     renderQuads(renderer: CoreRenderer): void;
     get id(): number;
     get x(): number;
@@ -112,8 +163,6 @@ export declare class CoreNode extends EventEmitter implements ICoreNode {
     set scaleX(value: number);
     get scaleY(): number;
     set scaleY(value: number);
-    get worldScaleX(): number;
-    get worldScaleY(): number;
     get mount(): number;
     set mount(value: number);
     get mountX(): number;
@@ -130,7 +179,6 @@ export declare class CoreNode extends EventEmitter implements ICoreNode {
     set rotation(value: number);
     get alpha(): number;
     set alpha(value: number);
-    get worldAlpha(): number;
     get clipping(): boolean;
     set clipping(value: boolean);
     get color(): number;