PIXI.CanvasMaskManager

class CanvasMaskManager

A set of functions used to handle masking.

Sprite masking is not supported on the CanvasRenderer.

Constructor

new PIXI.CanvasMaskManager(renderer: PIXI.CanvasRenderer) → {}

Parameters:
Name	Type	Description
renderer	PIXI.CanvasRenderer	A reference to the current renderer

void	destroy() Destroys this canvas mask manager.
void	popMask(renderer: PIXI.CanvasRenderer)
void	pushMask(maskData: PIXI.MaskData \| PIXI.Graphics)
void	recursiveFindShapes(container: PIXI.Container, out: Array<PIXI.Graphics>)
void	renderGraphicsShape(graphics: PIXI.Graphics)

destroy CanvasMaskManager.ts:258

destroy() → {void}

Destroys this canvas mask manager.

Returns:
Type	Description
void

popMask CanvasMaskManager.ts:248

popMask(renderer: PIXI.CanvasRenderer) → {void}

Restores the current drawing context to the state it was before the mask was applied.

Parameters:
Name	Type	Description
renderer	PIXI.CanvasRenderer	The renderer context to use.

Returns:
Type	Description
void

pushMask CanvasMaskManager.ts:28

pushMask(maskData: PIXI.MaskData | PIXI.Graphics) → {void}

This method adds it to the current stack of masks.

Parameters:
Name	Type	Description
maskData	PIXI.MaskData \| PIXI.Graphics	the maskData that will be pushed

Returns:
Type	Description
void

recursiveFindShapes CanvasMaskManager.ts:66

recursiveFindShapes(container: PIXI.Container, out: Array<PIXI.Graphics>) → {void}

Renders all PIXI.Graphics shapes in a subtree.

Parameters:
Name	Type	Description
container	PIXI.Container	container to scan.
out	Array<PIXI.Graphics>	where to put found shapes

Returns:
Type	Description
void

renderGraphicsShape CanvasMaskManager.ts:89

renderGraphicsShape(graphics: PIXI.Graphics) → {void}

Renders a PIXI.Graphics shape.

Parameters:
Name	Type	Description
graphics	PIXI.Graphics	The object to render.

Returns:
Type	Description
void