SortLayer
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:8
A managed sort layer containing sprites.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SortLayer(
config):SortLayer
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:44
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”SortLayer
Properties
Section titled “Properties”blendMode
Section titled “blendMode”blendMode:
BlendMode
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:27
Blend mode for this layer.
readonlyname:string
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:12
Layer name.
onVisibilityChange?
Section titled “onVisibilityChange?”
optionalonVisibilityChange?: (visible) =>void
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:42
Callback when visibility changes.
Parameters
Section titled “Parameters”visible
Section titled “visible”boolean
Returns
Section titled “Returns”void
sortMode
Section titled “sortMode”sortMode:
SortMode
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:32
Sort mode for sprites in this layer.
readonlyvalue:number
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:17
Layer value (render order).
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get count():
number
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:62
Get sprite count.
Returns
Section titled “Returns”number
sprites
Section titled “sprites”Get Signature
Section titled “Get Signature”get sprites():
ReadonlySet<Sprite2D>
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:55
Get sprites in this layer.
Returns
Section titled “Returns”ReadonlySet<Sprite2D>
visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:69
Get visibility.
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
value):void
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:76
Set visibility.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
Iterator<Sprite2D>
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:121
Iterate over sprites in this layer.
Returns
Section titled “Returns”Iterator<Sprite2D>
add(
sprite):void
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:91
Add a sprite to this layer.
Parameters
Section titled “Parameters”sprite
Section titled “sprite”Returns
Section titled “Returns”void
clear()
Section titled “clear()”clear():
void
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:114
Clear all sprites from this layer.
Returns
Section titled “Returns”void
has(
sprite):boolean
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:107
Check if layer contains a sprite.
Parameters
Section titled “Parameters”sprite
Section titled “sprite”Returns
Section titled “Returns”boolean
remove()
Section titled “remove()”remove(
sprite):void
Defined in: packages/three-flatland/src/pipeline/SortLayerManager.ts:100
Remove a sprite from this layer.
Parameters
Section titled “Parameters”sprite
Section titled “sprite”Returns
Section titled “Returns”void