MaskHandle
Defined in: renderer/src/masks/MaskHandle.ts:7
Public handle returned by setMask / attachMask. Idempotent on
remove(). Mirrors the EffectHandle ergonomics so the two APIs
feel like siblings without sharing a stack abstraction (masks are
exclusive — one per container — so they don’t compose like effects do).
Properties
Section titled “Properties”inverse
Section titled “inverse”
readonlyinverse:boolean
Defined in: renderer/src/masks/MaskHandle.ts:22
Current inverse state.
Methods
Section titled “Methods”redraw()
Section titled “redraw()”redraw():
void
Defined in: renderer/src/masks/MaskHandle.ts:29
Re-run the original draw function on a graphicsMask. No-op for
rectMask / spriteMask. Call this whenever the data the draw closure
depends on changes (e.g. after a layout pass updates dimensions).
Returns
Section titled “Returns”void
remove()
Section titled “remove()”remove():
void
Defined in: renderer/src/masks/MaskHandle.ts:13
Detach the mask from its target. Destroys the underlying mask node when the factory owned it (rect/graphics) and leaves user-supplied nodes (sprite) intact. Safe to call repeatedly.
Returns
Section titled “Returns”void
serialize()
Section titled “serialize()”serialize():
MaskSnapshot|null
Defined in: renderer/src/masks/MaskHandle.ts:37
Serialize this mask’s definition + state for save/load. Returns null
for masks that can’t be reproduced from a snapshot — spriteMask (holds
a Sprite reference) and graphicsMask (holds a draw closure). Only
masks built from defineMask-registered factories return a snapshot.
Returns
Section titled “Returns”MaskSnapshot | null
setInverse()
Section titled “setInverse()”setInverse(
on):void
Defined in: renderer/src/masks/MaskHandle.ts:19
Toggle inverse-mask mode. Forwards to pixi v8
Container.setMask({ mask, inverse }).
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void