@lightningjs/renderer
    Preparing search index...

    Interface ITextNode

    A visual Node in the Renderer scene graph that renders text.

    A Text Node is a special type of Node that renders text using a specific text renderer, such as Web/Canvas or Signed Distance Field (SDF) text.

    For non-text rendering, see INode.

    Users of the Renderer API, should generally interact with ITextNode objects instead of CoreTextNode objects.

    interface ITextNode {
        absX: number;
        absY: number;
        alpha: number;
        autosize: boolean;
        autosizer: null | Autosizer;
        boundsMargin: null | number | [number, number, number, number];
        calcZIndex: number;
        children: CoreNode[];
        childUpdateType: UpdateType;
        clipping: boolean;
        clippingRect: RectWithValid;
        color: number;
        colorBl: number;
        colorBottom: number;
        colorBr: number;
        colorLeft: number;
        colorRight: number;
        colorTl: number;
        colorTop: number;
        colorTr: number;
        contain: "none" | "both" | "height" | "width";
        data: undefined | CustomDataMap;
        destroyed: boolean;
        fontFamily: string;
        fontSize: number;
        fontStyle: "normal" | "italic" | "oblique";
        forceLoad: boolean;
        framebufferDimensions: null | Dimensions;
        globalTransform?: Matrix3d;
        h: number;
        hasRTTupdates: boolean;
        hasShaderTimeFn: boolean;
        id: number;
        imageType: null | "svg" | "regular" | "compressed";
        interactive: undefined | boolean;
        isCoreNode: true;
        isRenderable: boolean;
        letterSpacing: number;
        lineHeight: number;
        localTransform?: Matrix3d;
        maxHeight: number;
        maxLines: number;
        maxWidth: number;
        mount: number;
        mountX: number;
        mountY: number;
        numQuads: number;
        offsetY: number;
        overflowSuffix: string;
        parent: null | INode<CoreShaderNode<Record<string, unknown>>>;
        parentAutosizer: null | Autosizer;
        parentFramebufferDimensions: null | Dimensions;
        parentHasRenderTexture: boolean;
        parentRenderTexture: null | CoreNode;
        pivot: number;
        pivotX: number;
        pivotY: number;
        preloadBound?: Bound;
        premultipliedColorBl: number;
        premultipliedColorBr: number;
        premultipliedColorTl: number;
        premultipliedColorTr: number;
        previousZIndex: number;
        props: CoreNodeProps;
        quadBufferCollection: BufferCollection;
        renderBound?: Bound;
        renderCoords?: RenderCoords;
        renderInfo: TextRenderInfo;
        renderOpBufferIdx: number;
        renderOpTextures: WebGlCoreCtxTexture[];
        renderState: CoreNodeRenderState;
        rotation: number;
        rtt: boolean;
        rttParent: null | CoreNode;
        scale: number;
        scaleX: number;
        scaleY: number;
        sceneGlobalTransform?: Matrix3d;
        sceneRenderCoords?: RenderCoords;
        shader: null | CoreShaderNode<any>;
        src: null | string;
        srcHeight: undefined | number;
        srcWidth: undefined | number;
        srcX: undefined | number;
        srcY: undefined | number;
        stage: Stage;
        strictBound?: Bound;
        text: string;
        textAlign: "center" | "left" | "right";
        texture: null | Texture;
        textureCoords?: Bound;
        textureOptions: TextureOptions;
        time: number;
        updateShaderUniforms: boolean;
        updateType: UpdateType;
        verticalAlign: TextVerticalAlign;
        w: number;
        wordBreak: "overflow" | "break-all" | "break-word";
        worldAlpha: number;
        x: number;
        y: number;
        zIndex: number;
        addChild(node: CoreNode, previousParent?: null | CoreNode): void;
        addTexture(texture: WebGlCoreCtxTexture): number;
        allowTextGeneration(): boolean;
        animate(
            props: Partial<INodeAnimateProps<CoreShaderNode>>,
            settings: Partial<AnimationSettings>,
        ): IAnimationController;
        calculateClippingRect(parentClippingRect: RectWithValid): void;
        calculateRenderCoords(): void;
        checkBasicRenderability(): boolean;
        checkRenderBounds(): CoreNodeRenderState;
        createRenderBounds(): void;
        destroy(): void;
        draw(renderer: WebGlCoreRenderer): void;
        emit(event: string, data?: any): void;
        flush(): void;
        getTimerValue(): number;
        hasDimensions(): boolean;
        isOutOfBounds(): boolean;
        loadTexture(): void;
        off(event: string, listener?: (target: any, data: any) => void): void;
        on(event: string, listener: (target: any, data: any) => void): void;
        once(event: string, listener: (target: any, data: any) => void): void;
        removeAllListeners(): void;
        removeChild(node: CoreNode, targetParent?: null | CoreNode): void;
        renderQuads(renderer: CoreRenderer): void;
        setRenderable(isRenderable: boolean): void;
        setRTTUpdates(type: number): void;
        setUpdateType(type: UpdateType): void;
        sortChildren(): void;
        unloadTexture(): void;
        update(delta: number, parentClippingRect: RectWithValid): void;
        updateBoundingRect(): void;
        updateIsRenderable(): void;
        updateLocalTransform(): void;
        updateRenderState(renderState: CoreNodeRenderState): void;
        updateTextureOwnership(isRenderable: boolean): void;
    }

    Hierarchy

    Index

    Properties

    absX absY alpha autosize autosizer boundsMargin calcZIndex children childUpdateType clipping clippingRect color colorBl colorBottom colorBr colorLeft colorRight colorTl colorTop colorTr contain data destroyed fontFamily fontSize fontStyle forceLoad framebufferDimensions globalTransform? h hasRTTupdates hasShaderTimeFn id imageType interactive isCoreNode isRenderable letterSpacing lineHeight localTransform? maxHeight maxLines maxWidth mount mountX mountY numQuads offsetY overflowSuffix parent parentAutosizer parentFramebufferDimensions parentHasRenderTexture parentRenderTexture pivot pivotX pivotY preloadBound? premultipliedColorBl premultipliedColorBr premultipliedColorTl premultipliedColorTr previousZIndex props quadBufferCollection renderBound? renderCoords? renderInfo renderOpBufferIdx renderOpTextures renderState rotation rtt rttParent scale scaleX scaleY sceneGlobalTransform? sceneRenderCoords? shader src srcHeight srcWidth srcX srcY stage strictBound? text textAlign texture textureCoords? textureOptions time updateShaderUniforms updateType verticalAlign w wordBreak worldAlpha x y zIndex

    Methods

    addChild addTexture allowTextGeneration animate calculateClippingRect calculateRenderCoords checkBasicRenderability checkRenderBounds createRenderBounds destroy draw emit flush getTimerValue hasDimensions isOutOfBounds loadTexture off on once removeAllListeners removeChild renderQuads setRenderable setRTTUpdates setUpdateType sortChildren unloadTexture update updateBoundingRect updateIsRenderable updateLocalTransform updateRenderState updateTextureOwnership

    Properties

    absX: number
    absY: number
    alpha: number
    autosize: boolean
    autosizer: null | Autosizer = null

    Autosize properties

    boundsMargin: null | number | [number, number, number, number]
    calcZIndex: number = 0
    children: CoreNode[] = []
    childUpdateType: UpdateType = UpdateType.None
    clipping: boolean
    clippingRect: RectWithValid = ...
    color: number
    colorBl: number
    colorBottom: number
    colorBr: number
    colorLeft: number
    colorRight: number
    colorTl: number
    colorTop: number
    colorTr: number
    contain: "none" | "both" | "height" | "width"
    data: undefined | CustomDataMap
    destroyed: boolean = false
    fontFamily: string
    fontSize: number
    fontStyle: "normal" | "italic" | "oblique"
    forceLoad: boolean
    framebufferDimensions: null | Dimensions = null

    only used when rtt = true

    globalTransform?: Matrix3d
    h: number
    hasRTTupdates: boolean = false
    hasShaderTimeFn: boolean = false
    id: number
    imageType: null | "svg" | "regular" | "compressed"
    interactive: undefined | boolean
    isCoreNode: true = ...
    isRenderable: boolean = false
    letterSpacing: number
    lineHeight: number
    localTransform?: Matrix3d
    maxHeight: number
    maxLines: number
    maxWidth: number
    mount: number
    mountX: number
    mountY: number
    numQuads: number = 0
    offsetY: number
    overflowSuffix: string
    parent: null | INode<CoreShaderNode<Record<string, unknown>>>
    parentAutosizer: null | Autosizer = null
    parentFramebufferDimensions: null | Dimensions
    parentHasRenderTexture: boolean = false
    parentRenderTexture: null | CoreNode
    pivot: number
    pivotX: number
    pivotY: number
    preloadBound?: Bound
    premultipliedColorBl: number = 0
    premultipliedColorBr: number = 0
    premultipliedColorTl: number = 0
    premultipliedColorTr: number = 0
    previousZIndex: number = -1
    props: CoreNodeProps
    quadBufferCollection: BufferCollection
    renderBound?: Bound
    renderCoords?: RenderCoords
    renderInfo: TextRenderInfo
    renderOpBufferIdx: number = 0
    renderOpTextures: WebGlCoreCtxTexture[] = []
    renderState: CoreNodeRenderState = CoreNodeRenderState.Init
    rotation: number
    rtt: boolean
    rttParent: null | CoreNode = null
    scale: number
    scaleX: number
    scaleY: number
    sceneGlobalTransform?: Matrix3d
    sceneRenderCoords?: RenderCoords
    shader: null | CoreShaderNode<any>
    src: null | string
    srcHeight: undefined | number
    srcWidth: undefined | number
    srcX: undefined | number
    srcY: undefined | number
    stage: Stage
    strictBound?: Bound

    text

    text: string
    textAlign: "center" | "left" | "right"
    texture: null | Texture
    textureCoords?: Bound
    textureOptions: TextureOptions
    time: number
    updateShaderUniforms: boolean = false
    updateType: UpdateType = UpdateType.All
    verticalAlign: TextVerticalAlign
    w: number
    wordBreak: "overflow" | "break-all" | "break-word"
    worldAlpha: number = 1
    x: number
    y: number
    zIndex: number

    Methods

    • This function calculates the clipping rectangle for a node.

      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. If a parent clipping rectangle exists, it is intersected with the node's clipping rectangle (if it exists), or replaces the node's clipping rectangle.

      Finally, the node's parentClippingRect and clippingRect properties are updated.

      Parameters

      • parentClippingRect: RectWithValid

      Returns void

    • Parameters

      • event: string
      • Optionallistener: (target: any, data: any) => void

      Returns void

    • Parameters

      • event: string
      • listener: (target: any, data: any) => void

      Returns void

    • Parameters

      • event: string
      • listener: (target: any, data: any) => void

      Returns void

    • Sets the renderable state and triggers changes if necessary.

      Parameters

      • isRenderable: boolean

        The new renderable state

      Returns void

    • Parameters

      • type: number

      Returns void

    • Change types types is used to determine the scope of the changes being applied

      Parameters

      • type: UpdateType

      Returns void

      See UpdateType for more information on each type

    • Override CoreNode's update method to handle text-specific updates

      Parameters

      • delta: number
      • parentClippingRect: RectWithValid

      Returns void

    • Changes the renderable state of the node.

      Parameters

      • isRenderable: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    absXabsYalphaautosizeautosizerboundsMargincalcZIndexchildrenchildUpdateTypeclippingclippingRectcolorcolorBlcolorBottomcolorBrcolorLeftcolorRightcolorTlcolorTopcolorTrcontaindatadestroyedfontFamilyfontSizefontStyleforceLoadframebufferDimensionsglobalTransformhhasRTTupdateshasShaderTimeFnidimageTypeinteractiveisCoreNodeisRenderableletterSpacinglineHeightlocalTransformmaxHeightmaxLinesmaxWidthmountmountXmountYnumQuadsoffsetYoverflowSuffixparentparentAutosizerparentFramebufferDimensionsparentHasRenderTextureparentRenderTexturepivotpivotXpivotYpreloadBoundpremultipliedColorBlpremultipliedColorBrpremultipliedColorTlpremultipliedColorTrpreviousZIndexpropsquadBufferCollectionrenderBoundrenderCoordsrenderInforenderOpBufferIdxrenderOpTexturesrenderStaterotationrttrttParentscalescaleXscaleYsceneGlobalTransformsceneRenderCoordsshadersrcsrcHeightsrcWidthsrcXsrcYstagestrictBoundtexttextAligntexturetextureCoordstextureOptionstimeupdateShaderUniformsupdateTypeverticalAlignwwordBreakworldAlphaxyzIndex
    Methods