PixiJS

Class: CanvasMaskSystem

PIXI.CanvasMaskSystem

A set of functions used to handle masking.

Sprite masking is not supported on the CanvasRenderer.

new PIXI.CanvasMaskSystem (renderer)

CanvasMaskSystem.ts:26
Name Type Description
renderer PIXI.CanvasRenderer

A reference to the current renderer

Implements

Methods

destroy () void

CanvasMaskSystem.ts:262

Destroys this canvas mask manager.

popMask (renderer) void

CanvasMaskSystem.ts:252

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

Name Type Description
renderer PIXI.CanvasRenderer

The renderer context to use.

pushMask (maskData) void

CanvasMaskSystem.ts:32

This method adds it to the current stack of masks.

Name Type Description
maskData PIXI.MaskData | PIXI.Graphics

the maskData that will be pushed

recursiveFindShapes (container, out) void

CanvasMaskSystem.ts:70

Renders all PIXI.Graphics shapes in a subtree.

Name Type Description
container PIXI.Container

container to scan.
out Array<PIXI.Graphics>

where to put found shapes

renderGraphicsShape (graphics) void

CanvasMaskSystem.ts:93

Renders a PIXI.Graphics shape.

Name Type Description
graphics PIXI.Graphics

The object to render.