RenderLayerManager
Defined in: renderer/src/RenderLayer.ts:132
Manages named render layers for a single scene. All layers are children of a single root container. Camera transforms are applied per-layer by the DisplaySystem based on CameraEntity bindings.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RenderLayerManager(
root,defaultEventMode?,queueFactory?):RenderLayerManager
Defined in: renderer/src/RenderLayer.ts:139
Parameters
Section titled “Parameters”Container
defaultEventMode?
Section titled “defaultEventMode?”EventMode
queueFactory?
Section titled “queueFactory?”EffectQueueFactory
Returns
Section titled “Returns”RenderLayerManager
Accessors
Section titled “Accessors”defaultLayer
Section titled “defaultLayer”Get Signature
Section titled “Get Signature”get defaultLayer():
RenderLayer
Defined in: renderer/src/RenderLayer.ts:230
The default layer (order 0).
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get root():
Container
Defined in: renderer/src/RenderLayer.ts:240
The root container holding all layers.
Returns
Section titled “Returns”Container
Methods
Section titled “Methods”create()
Section titled “create()”create(
name,order,opts?):RenderLayer
Defined in: renderer/src/RenderLayer.ts:151
Create a new named layer. Throws if name already exists.
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”createFromDef()
Section titled “createFromDef()”createFromDef(
def,opts?):RenderLayer
Defined in: renderer/src/RenderLayer.ts:196
Create a layer from a declarative LayerDef. Fields on the def
(space, sortableChildren) take precedence over the runtime opts
so a scene’s declaration stays authoritative; opts is primarily for
plugin-side overrides when auto-provisioning a layer the scene didn’t
declare (via ensureLayer).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”destroy()
Section titled “destroy()”destroy():
void
Defined in: renderer/src/RenderLayer.ts:267
Clear internal state. Call after the root container has been destroyed.
Returns
Section titled “Returns”void
destroyEffects()
Section titled “destroyEffects()”destroyEffects():
void
Defined in: renderer/src/RenderLayer.ts:250
Tear down every layer’s effect stack. Call BEFORE the root container is destroyed so external (user-assigned) filters get preserved by each stack’s destroy logic instead of being clobbered by the container teardown.
Returns
Section titled “Returns”void
destroyMasks()
Section titled “destroyMasks()”destroyMasks():
void
Defined in: renderer/src/RenderLayer.ts:260
Tear down every layer’s mask. Call BEFORE the root container is destroyed so owned mask Graphics get destroyed exactly once.
Returns
Section titled “Returns”void
get(
name):RenderLayer
Defined in: renderer/src/RenderLayer.ts:207
Get a layer by name. Throws if not found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”getAll()
Section titled “getAll()”getAll(): readonly
RenderLayer[]
Defined in: renderer/src/RenderLayer.ts:235
All layers sorted by draw order.
Returns
Section titled “Returns”readonly RenderLayer[]
getOrCreate()
Section titled “getOrCreate()”getOrCreate(
name,order,opts?):RenderLayer
Defined in: renderer/src/RenderLayer.ts:221
Get an existing layer, or create it if it doesn’t exist.
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”tryGet()
Section titled “tryGet()”tryGet(
name):RenderLayer|undefined
Defined in: renderer/src/RenderLayer.ts:216
Get a layer by name, returning undefined if not found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”RenderLayer | undefined