Class: MaskSystem

Extends

• PIXI.System

Members

alphaMaskIndex number readonly

Current index of alpha mask pool

Default Value:

• 0

alphaMaskPool Array.<PIXI.SpriteMaskFilter> readonly

Pool of used sprite mask filters

enableScissor boolean readonly

Enable scissor

renderer PIXI.Renderer inherited

The renderer this manager works for.

scissor boolean readonly

true if current pushed masked is scissor

scissorData PIXI.Graphics readonly

Mask data

scissorRenderTarget PIXI.DisplayObject readonly

Target to mask

Methods

contextChange (gl) inherited

System.js:32

Generic method called when there is a WebGL context change.

Name	Type	Description
gl	WebGLRenderingContext	new webgl context

destroy () inherited

System.js:40

Generic destroy methods to be overridden by the subclass

pop (target, maskData)

MaskSystem.js:117

Removes the last mask from the mask stack and doesn't return it.

Name	Type	Description
target	PIXI.DisplayObject	Display Object to pop the mask from
maskData	PIXI.Sprite | PIXI.Graphics	The masking data.

popScissorMask ()

MaskSystem.js:227

Pop scissor mask

popSpriteMask ()

MaskSystem.js:164

Removes the last filter from the filter stack and doesn't return it.

popStencilMask ()

MaskSystem.js:185

Removes the last filter from the filter stack and doesn't return it.

push (target, maskData)

MaskSystem.js:73

Applies the Mask and adds it to the current filter stack.

Name	Type	Description
target	PIXI.DisplayObject	Display Object to push the mask to
maskData	PIXI.Sprite | PIXI.Graphics	The masking data.

pushScissorMask (target, maskData)

MaskSystem.js:196

Name	Type	Description
target	PIXI.DisplayObject	Display Object to push the mask to
maskData	PIXI.Graphics	The masking data.

pushSpriteMask (target, maskData)

MaskSystem.js:139

Applies the Mask and adds it to the current filter stack.

Name	Type	Description
target	PIXI.RenderTexture	Display Object to push the sprite mask to
maskData	PIXI.Sprite	Sprite to be used as the mask

pushStencilMask (maskData)

MaskSystem.js:175

Applies the Mask and adds it to the current filter stack.

Name	Type	Description
maskData	PIXI.Sprite | PIXI.Graphics	The masking data.