These docs are for Phaser 2.6.2 Phaser 3 docs can be found on GitHub pages.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

PIXI. CanvasMaskManager

new CanvasMaskManager()

A set of functions used to handle masking.

Source code: pixi/renderers/canvas/utils/CanvasMaskManager.js (Line 5)

Public Methods

popMask(renderSession)

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

Parameters
Name Type Description
renderSession Object

The renderSession whose context will be used for this mask manager.

Source code: pixi/renderers/canvas/utils/CanvasMaskManager.js (Line 49)

pushMask(maskData, renderSession)

This method adds it to the current stack of masks.

Parameters
Name Type Description
maskData Object

the maskData that will be pushed

renderSession Object

The renderSession whose context will be used for this mask manager.

Source code: pixi/renderers/canvas/utils/CanvasMaskManager.js (Line 17)