Class: LayerStack

Defined in: layers.ts:2166

Layer stack manager

Constructors

Constructor

new LayerStack(): LayerStack;

Defined in: layers.ts:2171

Returns

LayerStack

Properties

needsComposite

needsComposite: boolean;

Defined in: layers.ts:2169

Methods

addLayer()

addLayer(layer): void;

Defined in: layers.ts:2177

Parameters

layer

Layer

Returns

void

---

removeLayer()

removeLayer(id): boolean;

Defined in: layers.ts:2190

Parameters

id

string

Returns

boolean

---

getLayer()

getLayer(id): Layer | undefined;

Defined in: layers.ts:2206

Parameters

id

string

Returns

Layer | undefined

---

updateLayer()

updateLayer(id, updates): void;

Defined in: layers.ts:2210

Parameters

id

string

updates

LayerUpdateData

Returns

void

---

getAllLayers()

getAllLayers(): Layer[];

Defined in: layers.ts:2225

Returns

Layer[]

---

getOrderedLayers()

getOrderedLayers(): readonly Layer[];

Defined in: layers.ts:2230

Return the exact bottom-to-top order used by CPU and GPU compositing.

Returns

readonly Layer[]

---

getLayerOrderDescriptors()

getLayerOrderDescriptors(): readonly LayerOrderDescriptor[];

Defined in: layers.ts:2236

Returns

readonly LayerOrderDescriptor[]

---

validateLayerOrder()

validateLayerOrder(ids): LayerOrderResult;

Defined in: layers.ts:2246

Validate a complete bottom-to-top order without mutating the stack.

Parameters

ids

readonly string[]

Returns

LayerOrderResult

---

setLayerOrder()

setLayerOrder(ids): LayerOrderResult;

Defined in: layers.ts:2280

Parameters

ids

readonly string[]

Returns

LayerOrderResult

---

moveLayer()

moveLayer(layerId, destinationIndex): LayerOrderResult;

Defined in: layers.ts:2289

Parameters

layerId

string

destinationIndex

number

Returns

LayerOrderResult

---

updateLayerOrder()

updateLayerOrder(): void;

Defined in: layers.ts:2320

Returns

void

Deprecated

LayerStack maintains canonical order automatically. This compatibility method repairs membership without consulting Layer.order.

---

getVisibleLayers()

getVisibleLayers(): Layer[];

Defined in: layers.ts:2329

Returns

Layer[]

---

clear()

clear(): void;

Defined in: layers.ts:2335

Returns

void

---

dispose()

dispose(): void;

Defined in: layers.ts:2347

Returns

void