Class Stage

constructor

• new Stage(options): Stage

• Stage constructor

  Parameters

  • options: StageOptions

  Returns Stage

ReadonlyanimationManager

boundsMargin

ReadonlybufferMemory

ReadonlycalculateTextureCoord

contextSpy

currentFrameTime

ReadonlydefaultTexture

ReadonlydefShaderNode

deltaTime

ReadonlyeventBus

ReadonlyfontHandlers

ReadonlyinteractiveNodes

lastFrameTime

options

pixelRatio

Readonlyplatform

preloadBound

Readonlyrenderer

Readonlyroot

ReadonlyshManager

strictBound

targetFrameTime

ReadonlytextRenderers

ReadonlytxManager

ReadonlytxMemManager

clearColor

• get clearColor(): number

• Returns number

• set clearColor(value): void

• Parameters

  • value: number

  Returns void

addQuads

• addQuads(node): void

• Parameters

  • node: CoreNode

  Returns void

calculateFps

• calculateFps(): void

• Returns void

calculateQuads

• calculateQuads(): void

• Returns void

cleanup

• cleanup(aggressive): void

• Cleanup Orphaned Textures

  Parameters

  • aggressive: boolean

  Returns void

  Remarks

  This method is used to cleanup orphaned textures that are no longer in use.

createDefaultTexture

• createDefaultTexture(): void

• Create default PixelTexture

  Returns void

createNode

• createNode(props): CoreNode

• Parameters

  • props: Partial<CoreNodeProps>

  Returns CoreNode

createTextNode

• createTextNode(props): CoreTextNode

• Parameters

  • props: Partial<CoreTextNodeProps>

  Returns CoreTextNode

drawFrame

• drawFrame(): void

• Start a new frame draw

  Returns void

findNodesAtPoint

• findNodesAtPoint(data): CoreNode[]

• Find all nodes at a given point

  Parameters

  • data: Point

  Returns CoreNode[]

flushFrameEvents

• flushFrameEvents(): void

• Emit all queued frame events

  Returns void

  Remarks

  This method should be called after the frame has been rendered to emit all events that were queued during the frame.

  See queueFrameEvent for more information.

getNodeFromPosition

• getNodeFromPosition(data): null | CoreNode

• Find the top node at a given point

  Parameters

  • data: Point

  Returns null | CoreNode

hasSceneUpdates

• hasSceneUpdates(): boolean

• Check if the scene has updates

  Returns boolean

loadFont

• loadFont(rendererType, options): Promise<void>

• Load a font using a specific text renderer type

  Parameters

  • rendererType: TextRenderers

    The type of text renderer ('canvas', 'sdf', etc.)
  • options: FontLoadOptions

    Font loading options specific to the renderer type

  Returns Promise<void>

  Promise that resolves when the font is loaded

  Remarks

  This method allows consumers to explicitly load fonts for a specific text renderer type (e.g., 'canvas', 'sdf'). Consumers must specify the renderer type to ensure fonts are loaded with the correct pipeline.

  For Canvas fonts, provide fontUrl (e.g., .ttf, .woff, .woff2) For SDF fonts, provide atlasUrl (image) and atlasDataUrl (JSON glyph data)

queueFrameEvent

• queueFrameEvent(name, data): void

• Queue an event to be emitted after the current/next frame is rendered

  Parameters

  • name: string
  • data: unknown

  Returns void

  Remarks

  When we are operating in the context of the render loop, we may want to emit events that are related to the current frame. However, we generally do NOT want to emit events directly in the middle of the render loop, since this could enable event handlers to modify the scene graph and cause unexpected behavior. Instead, we queue up events to be emitted and then flush the queue after the frame has been rendered.

requestRender

• requestRender(): void

• Request a render pass without forcing an update

  Returns void

resolveTextRenderer

• resolveTextRenderer(trProps, textRendererOverride?): null | TextRenderer

• Given a font name, and possible renderer override, return the best compatible text renderer.

  Parameters

  • trProps: TrProps
  • textRendererOverride:
        | null
        | number
        | typeof iterator
        | "length"
        | "toString"
        | "charAt"
        | "charCodeAt"
        | "concat"
        | "indexOf"
        | "lastIndexOf"
        | "localeCompare"
        | "match"
        | "replace"
        | "search"
        | "slice"
        | "split"
        | "substring"
        | "toLowerCase"
        | "toLocaleLowerCase"
        | "toUpperCase"
        | "toLocaleUpperCase"
        | "trim"
        | "substr"
        | "valueOf"
        | "codePointAt"
        | "includes"
        | "endsWith"
        | "normalize"
        | "repeat"
        | "startsWith"
        | "anchor"
        | "big"
        | "blink"
        | "bold"
        | "fixed"
        | "fontcolor"
        | "fontsize"
        | "italics"
        | "link"
        | "small"
        | "strike"
        | "sub"
        | "sup"
        | "padStart"
        | "padEnd"
        | "trimEnd"
        | "trimStart"
        | "trimLeft"
        | "trimRight"
        | "matchAll"
        | "replaceAll"
        | "at" = null

  Returns null | TextRenderer

  Remarks

  Will try to return a canvas renderer if no other suitable renderer can be resolved.

setBoundsMargin

• setBoundsMargin(value): void

• Parameters

  • value: number | [number, number, number, number]

  Returns void

setClearColor

• setClearColor(color): void

• Parameters

  • color: number

  Returns void

updateAnimations

• updateAnimations(): void

• Update animations

  Returns void

updateFrameTime

• updateFrameTime(): void

• Returns void

updateTargetFrameTime

• updateTargetFrameTime(): void

• Update the target frame time based on the current targetFPS setting

  Returns void

  Remarks

  This should be called whenever the targetFPS option is changed to ensure targetFrameTime stays in sync. targetFPS of 0 means no throttling (targetFrameTime = 0) targetFPS > 0 means throttle to 1000/targetFPS milliseconds

updateViewportBounds

• updateViewportBounds(): void

• Update the viewport bounds

  Returns void