SceneRenderTreeProviderImpl

Defined in: renderer/src/SceneRenderTreeProvider.ts:227

Materializes a per-scene render tree with one root container per scene, added as a direct child of the renderer plugin’s _worldRoot container (which itself sits under app.stage, but holds the fit transform — see RendererPlugin._worldRoot for the rationale). Registered under SceneRenderTreeProviderKey by the renderer plugin.

app.stage                  // identity
 └── _worldRoot           // fit transform lives here
      ├── scene A root
      │    ├── layer "bg" (order -10)
      │    ├── layer "world" (order 0)
      │    └── layer "hud" (order 100)
      └── scene B root
           └── ...

A scene that uses renderAboveEffects also owns a Pixi RenderLayer placed immediately after its root, so the nodes attached to it draw after the scene’s layers and outside the scene root’s filters and mask.

Implements

• SceneRenderTreeProvider

Constructors

Constructor

new SceneRenderTreeProviderImpl(stage, processSystem?): SceneRenderTreeProviderImpl

Defined in: renderer/src/SceneRenderTreeProvider.ts:230

Parameters

stage

DisplayContainer

processSystem?

ProcessSystem

Returns

SceneRenderTreeProviderImpl

Methods

allTrees()

allTrees(): IterableIterator<[Scene, SceneRenderTree]>

Defined in: renderer/src/SceneRenderTreeProvider.ts:300

Iterate every live scene/tree pair.

Returns

IterableIterator<[Scene, SceneRenderTree]>

Implementation of

SceneRenderTreeProvider.allTrees

---

applyTransparentBelow()

applyTransparentBelow(stack): void

Defined in: renderer/src/SceneRenderTreeProvider.ts:326

Internal

Hide below-stack scene trees whose top neighbour has transparentBelow = false. The topmost scene is always visible; below neighbours stay visible only while every scene above them is transparentBelow = true. Detached scenes (mounted via _mountDetached, e.g. the debug overlay) are not in the stack and their visibility is left alone.

Parameters

stack

readonly Scene[]

Returns

void

---

bringSceneToFront()

bringSceneToFront(scene): void

Defined in: renderer/src/SceneRenderTreeProvider.ts:306

Reorder the scene’s container to render on top of its root peers.

Parameters

scene

Scene

Returns

void

Implementation of

SceneRenderTreeProvider.bringSceneToFront

---

createForScene()

createForScene(scene): SceneRenderTree

Defined in: renderer/src/SceneRenderTreeProvider.ts:235

Parameters

scene

Scene

Returns

SceneRenderTree

Implementation of

SceneRenderTreeProvider.createForScene

---

destroyAll()

destroyAll(): void

Defined in: renderer/src/SceneRenderTreeProvider.ts:354

Destroy every tracked scene’s tree. Used on renderer shutdown.

Returns

void

---

destroyForScene()

destroyForScene(scene): void

Defined in: renderer/src/SceneRenderTreeProvider.ts:278

Parameters

scene

Scene

Returns

void

Implementation of

SceneRenderTreeProvider.destroyForScene

---

getTree()

getTree(scene): SceneRenderTree | undefined

Defined in: renderer/src/SceneRenderTreeProvider.ts:296

Look up the render tree for a given scene.

Parameters

scene

Scene

Returns

SceneRenderTree | undefined

Implementation of

SceneRenderTreeProvider.getTree

---

resetVisibility()

resetVisibility(stack): void

Defined in: renderer/src/SceneRenderTreeProvider.ts:346

Internal

Restore in-stack scene roots to visible. Used while a scene transition runs so both the outgoing and incoming scenes can render even when the new topmost scene has transparentBelow = false; the visibility chain is reapplied when the transition ends. Detached scenes (mounted via _mountDetached, e.g. the debug overlay) are left alone — same contract as applyTransparentBelow, so callers can hide a detached root without it being silently un-hidden on every transition start.

Parameters

stack

readonly Scene[]

Returns

void