PIXI.StencilSystem

class StencilSystem extends PIXI.AbstractMaskSystem

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

Constructor

new PIXI.StencilSystem(renderer: PIXI.Renderer) → {}

Parameters:
Name	Type	Description
renderer	PIXI.Renderer	The renderer this System works for.

void

pop(maskObject: PIXI.DisplayObject)

void

push(maskData: PIXI.MaskData)

Array<PIXI.MaskData>

protected maskStack

void

destroy()

Destroys the mask stack.

number

getStackLength()

Gets count of masks of certain type.

void

pop StencilSystem.ts:87

pop(maskObject: PIXI.DisplayObject) → {void}

Pops stencil mask. MaskData is already removed from stack

Parameters:
Name	Type	Description
maskObject	PIXI.DisplayObject	object of popped mask data

Returns:
Type	Description
void

push StencilSystem.ts:35

push(maskData: PIXI.MaskData) → {void}

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

Parameters:
Name	Type	Description
maskData	PIXI.MaskData	The mask data

Returns:
Type	Description
void