@lightningjs/renderer 2.16.0 → 3.0.0-beta10

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

@@ -1,103 +1,74 @@
-import type { TextRenderer, TextRendererMap, TrProps, TextRendererState } from './text-rendering/renderers/TextRenderer.js';
+import type { TextRenderer, TrProps, TextRenderInfo } from './text-rendering/TextRenderer.js';
 import { CoreNode, type CoreNodeProps } from './CoreNode.js';
 import type { Stage } from './Stage.js';
-import type { CoreRenderer } from './renderers/CoreRenderer.js';
 import type { RectWithValid } from './lib/utils.js';
+import type { CoreRenderer } from './renderers/CoreRenderer.js';
+import type { TextureLoadedEventHandler } from './textures/Texture.js';
 export interface CoreTextNodeProps extends CoreNodeProps, TrProps {
     /**
      * Force Text Node to use a specific Text Renderer
-     *
-     * @remarks
-     * By default, Text Nodes resolve the Text Renderer to use based on the font
-     * that is matched using the font family and other font selection properties.
-     *
-     * If two fonts supported by two separate Text Renderers are matched setting
-     * this override forces the Text Node to resolve to the Text Renderer defined
-     * here.
-     *
-     * @default null
      */
-    textRendererOverride: keyof TextRendererMap | null;
+    textRendererOverride?: string | null;
+    forceLoad: boolean;
 }
-/**
- * An CoreNode in the Renderer scene graph that renders text.
- *
- * @remarks
- * A Text Node is the second graphical building block of the Renderer scene
- * graph. It renders text using a specific text renderer that is automatically
- * chosen based on the font requested and what type of fonts are installed
- * into an app.
- *
- * The text renderer can be overridden by setting the `textRendererOverride`
- *
- * The `texture` and `shader` properties are managed by loaded text renderer and
- * should not be set directly.
- *
- * For non-text rendering, see {@link CoreNode}.
- */
 export declare class CoreTextNode extends CoreNode implements CoreTextNodeProps {
-    textRenderer: TextRenderer;
-    trState: TextRendererState;
-    private _textRendererOverride;
+    private textRenderer;
+    private fontHandler;
+    private _layoutGenerated;
+    private _cachedLayout;
+    private _lastVertexBuffer;
+    private textProps;
+    private _renderInfo;
+    private _type;
     constructor(stage: Stage, props: CoreTextNodeProps, textRenderer: TextRenderer);
-    private onTextLoaded;
-    private onTextFailed;
-    get width(): number;
-    set width(value: number);
-    get height(): number;
-    set height(value: number);
-    get color(): number;
-    set color(value: number);
-    get text(): string;
-    set text(value: string);
-    get textRendererOverride(): CoreTextNodeProps['textRendererOverride'];
-    set textRendererOverride(value: CoreTextNodeProps['textRendererOverride']);
-    get fontSize(): CoreTextNodeProps['fontSize'];
-    set fontSize(value: CoreTextNodeProps['fontSize']);
-    get fontFamily(): CoreTextNodeProps['fontFamily'];
-    set fontFamily(value: CoreTextNodeProps['fontFamily']);
-    get fontStretch(): CoreTextNodeProps['fontStretch'];
-    set fontStretch(value: CoreTextNodeProps['fontStretch']);
-    get fontStyle(): CoreTextNodeProps['fontStyle'];
-    set fontStyle(value: CoreTextNodeProps['fontStyle']);
-    get fontWeight(): CoreTextNodeProps['fontWeight'];
-    set fontWeight(value: CoreTextNodeProps['fontWeight']);
-    get textAlign(): CoreTextNodeProps['textAlign'];
-    set textAlign(value: CoreTextNodeProps['textAlign']);
-    get contain(): CoreTextNodeProps['contain'];
-    set contain(value: CoreTextNodeProps['contain']);
-    get scrollable(): CoreTextNodeProps['scrollable'];
-    set scrollable(value: CoreTextNodeProps['scrollable']);
-    get scrollY(): CoreTextNodeProps['scrollY'];
-    set scrollY(value: CoreTextNodeProps['scrollY']);
-    get offsetY(): CoreTextNodeProps['offsetY'];
-    set offsetY(value: CoreTextNodeProps['offsetY']);
-    get letterSpacing(): CoreTextNodeProps['letterSpacing'];
-    set letterSpacing(value: CoreTextNodeProps['letterSpacing']);
-    get lineHeight(): CoreTextNodeProps['lineHeight'];
-    set lineHeight(value: CoreTextNodeProps['lineHeight']);
-    get maxLines(): CoreTextNodeProps['maxLines'];
-    set maxLines(value: CoreTextNodeProps['maxLines']);
-    get textBaseline(): CoreTextNodeProps['textBaseline'];
-    set textBaseline(value: CoreTextNodeProps['textBaseline']);
-    get verticalAlign(): CoreTextNodeProps['verticalAlign'];
-    set verticalAlign(value: CoreTextNodeProps['verticalAlign']);
-    get overflowSuffix(): CoreTextNodeProps['overflowSuffix'];
-    set overflowSuffix(value: CoreTextNodeProps['overflowSuffix']);
-    get debug(): CoreTextNodeProps['debug'];
-    set debug(value: CoreTextNodeProps['debug']);
+    protected onTextureLoaded: TextureLoadedEventHandler;
+    /**
+     * Override CoreNode's update method to handle text-specific updates
+     */
     update(delta: number, parentClippingRect: RectWithValid): void;
-    checkBasicRenderability(): boolean;
-    setRenderable(isRenderable: boolean): void;
-    renderQuads(renderer: CoreRenderer): void;
     /**
-     * Destroy the node and cleanup all resources
+     * Override is renderable check for SDF text nodes
+     */
+    updateIsRenderable(): void;
+    /**
+     * Handle the result of text rendering for both Canvas and SDF renderers
      */
-    destroy(): void;
+    private handleRenderResult;
     /**
-     * Resolve a text renderer and a new state based on the current text renderer props provided
-     * @param props
-     * @returns
+     * Override renderQuads to handle SDF vs Canvas rendering
      */
-    private createState;
+    renderQuads(renderer: CoreRenderer): void;
+    get maxWidth(): number;
+    set maxWidth(value: number);
+    get maxHeight(): number;
+    set maxHeight(value: number);
+    get text(): string;
+    set text(value: string);
+    get fontSize(): number;
+    set fontSize(value: number);
+    get fontFamily(): string;
+    set fontFamily(value: string);
+    get fontStyle(): TrProps['fontStyle'];
+    set fontStyle(value: TrProps['fontStyle']);
+    get textAlign(): TrProps['textAlign'];
+    set textAlign(value: TrProps['textAlign']);
+    get letterSpacing(): number;
+    set letterSpacing(value: number);
+    get lineHeight(): number;
+    set lineHeight(value: number);
+    get maxLines(): number;
+    set maxLines(value: number);
+    get textBaseline(): TrProps['textBaseline'];
+    set textBaseline(value: TrProps['textBaseline']);
+    get verticalAlign(): TrProps['verticalAlign'];
+    set verticalAlign(value: TrProps['verticalAlign']);
+    get overflowSuffix(): string;
+    set overflowSuffix(value: string);
+    get wordBreak(): TrProps['wordBreak'];
+    set wordBreak(value: TrProps['wordBreak']);
+    get offsetY(): number;
+    set offsetY(value: number);
+    get forceLoad(): boolean;
+    set forceLoad(value: boolean);
+    get renderInfo(): TextRenderInfo;
 }