Class StencilSystem

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

Memberof

PIXI

Hierarchy

AbstractMaskSystem
- StencilSystem

Index

Constructors

Properties

maskStack renderer

Methods

destroy getStackLength pop push setMaskStack

Constructors

constructor

new StencilSystem(renderer: Renderer): StencilSystem
Parameters
- renderer: Renderer
  The renderer this System works for.
Returns StencilSystem
Overrides AbstractMaskSystem.constructor
- Defined in node_modules/@pixi/core/lib/mask/StencilSystem.d.ts:15

Properties

`Protected`maskStack

maskStack: MaskData[]

The mask stack

Member

`Protected`renderer

renderer: Renderer

Methods

destroy

destroy(): void
Destroys the mask stack.

Returns void
Inherited from AbstractMaskSystem.destroy
- Defined in node_modules/@pixi/core/lib/mask/AbstractMaskSystem.d.ts:37

getStackLength

getStackLength(): number
Gets count of masks of certain type.

Returns number
Overrides AbstractMaskSystem.getStackLength
- Defined in node_modules/@pixi/core/lib/mask/StencilSystem.d.ts:16

pop

pop(maskObject: IMaskTarget): void
Pops stencil mask. MaskData is already removed from stack
Parameters
- maskObject: IMaskTarget
  object of popped mask data
Returns void
- Defined in node_modules/@pixi/core/lib/mask/StencilSystem.d.ts:26

push

push(maskData: MaskData): void
Applies the Mask and adds it to the current stencil stack.
Parameters
- maskData: MaskData
  The mask data
Returns void
- Defined in node_modules/@pixi/core/lib/mask/StencilSystem.d.ts:21

setMaskStack

setMaskStack(maskStack: MaskData[]): void
Changes the mask stack that is used by this System.
Parameters
- maskStack: MaskData[]
  The mask stack
Returns void
Inherited from AbstractMaskSystem.setMaskStack
- Defined in node_modules/@pixi/core/lib/mask/AbstractMaskSystem.d.ts:30