Class Stage

Constructors

constructor

Properties

animationManager boundsMargin bufferMemory calculateTextureCoord contextSpy currentFrameTime defaultTexture defShaderNode deltaTime eventBus fontManager interactiveNodes lastFrameTime options pixelRatio platform preloadBound renderer root shManager strictBound strictBounds targetFrameTime textRenderers txManager txMemManager

Accessors

clearColor

Methods

addQuads calculateFps calculateQuads cleanup createDefaultTexture createNode createTextNode drawFrame findNodesAtPoint flushFrameEvents getNodeFromPosition hasSceneUpdates queueFrameEvent requestRender resolveNodeDefaults resolveTextRenderer setBoundsMargin setClearColor updateAnimations updateFrameTime updateTargetFrameTime updateViewportBounds

Constructors

constructor

Properties

ReadonlyanimationManager

animationManager: AnimationManager

boundsMargin

boundsMargin: [number, number, number, number]

ReadonlybufferMemory

bufferMemory: number = 2e6

ReadonlycalculateTextureCoord

calculateTextureCoord: boolean

contextSpy

contextSpy: null | ContextSpy = null

currentFrameTime

currentFrameTime: number = 0

ReadonlydefaultTexture

defaultTexture: null | Texture = null

ReadonlydefShaderNode

defShaderNode: null | CoreShaderNode<Record<string, unknown>> = null

deltaTime

deltaTime: number = 0

ReadonlyeventBus

eventBus: EventEmitter

Renderer Event Bus for the Stage to emit events onto

Remarks

In reality this is just the RendererMain instance, which is an EventEmitter. this allows us to directly emit events from the Stage to RendererMain without having to set up forwarding handlers.

ReadonlyfontManager

fontManager: TrFontManager

ReadonlyinteractiveNodes

interactiveNodes: Set<CoreNode> = ...

lastFrameTime

lastFrameTime: number = 0

options

options: StageOptions

pixelRatio

pixelRatio: number

Readonlyplatform

platform: Platform | WebPlatform

preloadBound

preloadBound: Bound

Readonlyrenderer

renderer: CoreRenderer

Readonlyroot

root: CoreNode

ReadonlyshManager

shManager: CoreShaderManager

strictBound

strictBound: Bound

ReadonlystrictBounds

strictBounds: boolean

targetFrameTime

targetFrameTime: number = 0

Target frame time in milliseconds (calculated from targetFPS)

Remarks

This is pre-calculated to avoid recalculating on every frame.

  • 0 means no throttling (use display refresh rate)

  • 0 means throttle to this frame time (1000 / targetFPS)

ReadonlytextRenderers

textRenderers: Partial<TextRendererMap>

ReadonlytxManager

txManager: CoreTextureManager

ReadonlytxMemManager

txMemManager: TextureMemoryManager

Accessors

clearColor

Methods

addQuads

calculateFps

calculateQuads

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

createNode

  • createNode(props): CoreNode

  • Parameters

    • props: Partial<CoreNodeProps>

    Returns CoreNode

createTextNode

  • createTextNode(props): CoreTextNode

  • Parameters

    • props: Partial<CoreTextNodeProps>

    Returns CoreTextNode

drawFrame

findNodesAtPoint

  • findNodesAtPoint(data): CoreNode[]

  • Find all nodes at a given point

    Parameters

    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

    Returns null | CoreNode

hasSceneUpdates

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

ProtectedresolveNodeDefaults

  • resolveNodeDefaults(props): CoreNodeProps

  • Resolves the default property values for a Node

    Parameters

    • props: Partial<CoreNodeProps>

    Returns CoreNodeProps

    Remarks

    This method is used internally by the RendererMain to resolve the default property values for a Node. It is exposed publicly so that it can be used by Core Driver implementations.

resolveTextRenderer

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

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

    Parameters

    • trProps: TrProps
    • textRendererOverride: null | (keyof TextRendererMap) = null

    Returns null | TextRenderer<TextRendererState>

    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

updateAnimations

updateFrameTime

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods