RenderLayerManager
Defined in: renderer/src/RenderLayer.ts:18
Manages named render layers attached to a stage container.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RenderLayerManager(
rootContainer,eventMode?):RenderLayerManager
Defined in: renderer/src/RenderLayer.ts:24
Parameters
Section titled “Parameters”rootContainer
Section titled “rootContainer”Container
eventMode?
Section titled “eventMode?”EventMode
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:73
The default layer (order 0).
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get root():
Container
Defined in: renderer/src/RenderLayer.ts:31
The root container that holds all layers.
Returns
Section titled “Returns”Container
Methods
Section titled “Methods”create()
Section titled “create()”create(
name,order):RenderLayer
Defined in: renderer/src/RenderLayer.ts:36
Create a new named layer at the given draw order. Throws if name already exists.
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”destroy()
Section titled “destroy()”destroy():
void
Defined in: renderer/src/RenderLayer.ts:83
Clear internal state. Call after the root container has been destroyed.
Returns
Section titled “Returns”void
get(
name):RenderLayer
Defined in: renderer/src/RenderLayer.ts:54
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:78
All layers sorted by draw order.
Returns
Section titled “Returns”readonly RenderLayer[]
getOrCreate()
Section titled “getOrCreate()”getOrCreate(
name,order):RenderLayer
Defined in: renderer/src/RenderLayer.ts:68
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:63
Get a layer by name, returning undefined if not found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”RenderLayer | undefined