Class Stage

Constructors

constructor

Properties

animationManager boundsMargin contextSpy currentFrameTime defShaderCtr deltaTime eventBus fontManager lastFrameTime options preloadBound renderer root shManager strictBound strictBounds textRenderers txManager txMemManager

Methods

addQuads calculateFps createNode createShaderCtr createTextNode drawFrame flushFrameEvents hasSceneUpdates queueFrameEvent requestRender resolveNodeDefaults resolveTextRenderer setClearColor updateAnimations updateFrameTime

Constructors

constructor

Properties

ReadonlyanimationManager

animationManager: AnimationManager

ReadonlyboundsMargin

boundsMargin: [number, number, number, number]

contextSpy

contextSpy: null | ContextSpy = null

currentFrameTime

currentFrameTime: number = 0

ReadonlydefShaderCtr

defShaderCtr: BaseShaderController

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

lastFrameTime

lastFrameTime: number = 0

Readonlyoptions

options: StageOptions

ReadonlypreloadBound

preloadBound: Bound

Readonlyrenderer

renderer: CoreRenderer

Readonlyroot

root: CoreNode

ReadonlyshManager

shManager: CoreShaderManager

ReadonlystrictBound

strictBound: Bound

ReadonlystrictBounds

strictBounds: boolean

ReadonlytextRenderers

textRenderers: Partial<TextRendererMap>

ReadonlytxManager

txManager: CoreTextureManager

ReadonlytxMemManager

txMemManager: TextureMemoryManager

Methods

addQuads

calculateFps

createNode

  • createNode(props): CoreNode

  • Parameters

    • props: Partial<CoreNodeProps>

    Returns CoreNode

createShaderCtr

createTextNode

  • createTextNode(props): CoreTextNode

  • Parameters

    • props: Partial<CoreTextNodeProps>

    Returns CoreTextNode

drawFrame

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.

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.

setClearColor

updateAnimations

updateFrameTime

Settings

Member Visibility

On This Page

Constructors
Properties
Methods