RenderLayer
Defined in: packages/renderer/src/RenderLayer.ts:60
A named rendering layer — a pixi container at a given draw order.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RenderLayer(
name,order,container,space?,queueFactory?,sort?):RenderLayer
Defined in: packages/renderer/src/RenderLayer.ts:78
Parameters
Section titled “Parameters”string
number
container
Section titled “container”Container
space?
Section titled “space?”LayerSpace = "world"
queueFactory?
Section titled “queueFactory?”EffectQueueFactory
Returns
Section titled “Returns”RenderLayer
Properties
Section titled “Properties”container
Section titled “container”
readonlycontainer:Container
Defined in: packages/renderer/src/RenderLayer.ts:63
readonlyfx:EffectsHost
Defined in: packages/renderer/src/RenderLayer.ts:75
Layer-scope effects host. .fx.addEffect(...) applies a filter to every
entity rendered through this layer (one full-screen render pass per
layer-scope effect, regardless of how many entities are in the layer).
Fades pause with the owning scene and are scaled by its timeScale,
matching component-scope behavior. Effects survive until the scene
exits or the handle is .remove()d.
readonlyname:string
Defined in: packages/renderer/src/RenderLayer.ts:61
readonlyorder:number
Defined in: packages/renderer/src/RenderLayer.ts:62
readonlyspace:LayerSpace
Defined in: packages/renderer/src/RenderLayer.ts:65
Coordinate space — see CreateLayerOptions.space.
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get sort():
LayerSortFn|undefined
Defined in: packages/renderer/src/RenderLayer.ts:101
Per-frame depth-key function, or undefined for insertion-order
rendering. Set via LayerDef.sort / CreateLayerOptions.sort at
creation, or setSort at runtime. DisplaySystem writes
child.zIndex = sort(child) on every child each Render phase.
Returns
Section titled “Returns”LayerSortFn | undefined
Methods
Section titled “Methods”_destroyMask()
Section titled “_destroyMask()”_destroyMask():
void
Defined in: packages/renderer/src/RenderLayer.ts:146
Internal
Tear down any layer-scope mask. Called by RenderLayerManager before
the layer’s container is destroyed so the owned mask Graphics gets
cleaned up exactly once.
Returns
Section titled “Returns”void
_restoreMask()
Section titled “_restoreMask()”_restoreMask(
snap):void
Defined in: packages/renderer/src/RenderLayer.ts:157
Internal
— used by the renderer’s snapshot contributor.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
_serializeMask()
Section titled “_serializeMask()”_serializeMask():
MaskSnapshot|undefined
Defined in: packages/renderer/src/RenderLayer.ts:152
Internal
— used by the renderer’s snapshot contributor.
Returns
Section titled “Returns”MaskSnapshot | undefined
clearMask()
Section titled “clearMask()”clearMask():
void
Defined in: packages/renderer/src/RenderLayer.ts:135
Detach and destroy the layer-scope mask, if any.
Returns
Section titled “Returns”void
setMask()
Section titled “setMask()”setMask(
factory):MaskHandle
Defined in: packages/renderer/src/RenderLayer.ts:128
Attach a mask to this layer’s container, replacing any existing mask. Returns a handle for inverse toggling, redraw (graphicsMask), or removal. Torn down on scene exit.
Parameters
Section titled “Parameters”factory
Section titled “factory”Returns
Section titled “Returns”setSort()
Section titled “setSort()”setSort(
sort):void
Defined in: packages/renderer/src/RenderLayer.ts:118
Set (or clear) this layer’s depth-key function at runtime, flipping
container.sortableChildren to match. Useful for opting the
auto-created "default" layer into ySort after the scene is live,
or toggling depth sorting on dynamically.
Passing undefined stops the per-frame re-sort, but does not
restore the original insertion order: Pixi reorders container.children
in place while sorting is on, so clearing sortableChildren only halts
further sorting — children keep their current (last-sorted) order and
zIndex. Re-establish paint order yourself if you need the original
sequence back.
Parameters
Section titled “Parameters”LayerSortFn | undefined
Returns
Section titled “Returns”void