Skip to content

SceneRenderTree

Defined in: renderer/src/SceneRenderTree.ts:21

Scene-owned render tree. Created by SceneRenderTreeProvider when a scene enters. Scoped DI: components resolve via this.use(SceneRenderTreeKey).

readonly defaultLayer: RenderLayer

Defined in: renderer/src/SceneRenderTree.ts:31

The auto-created “default” layer (order 0).


readonly root: Container

Defined in: renderer/src/SceneRenderTree.ts:23

The single root container for the scene. Direct child of app.stage.

ensureLayer(def, opts?): RenderLayer

Defined in: renderer/src/SceneRenderTree.ts:38

Get an existing layer or create it from the given definition. Used by plugins like UI that auto-provision a layer if the game didn’t declare one explicitly. Pass { space: "screen" } so a default camera leaves the layer fixed to the viewport (e.g. screen-space HUD).

LayerDef

EnsureLayerOptions

RenderLayer


get(name): RenderLayer

Defined in: renderer/src/SceneRenderTree.ts:25

Get a layer by name. Throws if not found.

string

RenderLayer


getAll(): readonly RenderLayer[]

Defined in: renderer/src/SceneRenderTree.ts:29

All layers, sorted by draw order.

readonly RenderLayer[]


tryGet(name): RenderLayer | undefined

Defined in: renderer/src/SceneRenderTree.ts:27

Get a layer by name, or undefined if not found.

string

RenderLayer | undefined