PixiJS

Class: StencilSystem

PIXI.systems.StencilSystem

System plugin to the renderer to manage stencils (used for masks).

new PIXI.systems.StencilSystem (renderer)

StencilSystem.js:12
Name Type Description
renderer PIXI.Renderer

The renderer this System works for.

Extends

Members

renderer PIXI.Renderer inherited

The renderer this manager works for.

stencilMaskStack Array.<PIXI.Graphics>

The mask stack

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

StencilSystem.js:139

Destroys the mask stack.

popStencil ()

StencilSystem.js:85

Removes the last mask from the stencil stack. @alvin

pushStencil (graphics)

StencilSystem.js:57

Applies the Mask and adds it to the current stencil stack. @alvin

Name Type Description
graphics PIXI.Graphics

The mask

setMaskStack (stencilMaskStack)

StencilSystem.js:33

Changes the mask stack that is used by this System.

Name Type Description
stencilMaskStack Array.<PIXI.Graphics>

The mask stack