Class: MaskSystem

PIXI.systems.MaskSystem

System plugin to the renderer to manage masks.

new PIXI.systems.MaskSystem (renderer)

Name Type Description
renderer PIXI.Renderer

The renderer this System works for.

Extends

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

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

Generic method called when there is a WebGL context change.

Name Type Description
gl WebGLRenderingContext

new webgl context

destroy () inherited

Generic destroy methods to be overridden by the subclass

pop (target, maskData)

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 ()

Pop scissor mask

popSpriteMask ()

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

popStencilMask ()

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

push (target, maskData)

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)

Name Type Description
target PIXI.DisplayObject

Display Object to push the mask to

maskData PIXI.Graphics

The masking data.

pushSpriteMask (target, maskData)

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)

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

Name Type Description
maskData PIXI.Sprite | PIXI.Graphics

The masking data.