Pixi’VNClass: StencilMaskPipe
Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMaskPipe.d.ts:9
Internal
Implements
Constructors
Constructor
> new StencilMaskPipe(renderer): StencilMaskPipe
Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMaskPipe.d.ts:17
Parameters
renderer
Returns
StencilMaskPipe
Properties
extension
> static extension: object
Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMaskPipe.d.ts:10
name
> readonly name: "stencilMask"
type
> readonly type: readonly [WebGLPipes, WebGPUPipes]
Methods
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMaskPipe.d.ts:21
Returns
void
execute()
> execute(instruction): void
Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMaskPipe.d.ts:20
this is where the actual instruction is executed - eg make the draw call activate a filter. Any instructions that have the same renderPipeId have their execute method called
Parameters
instruction
the instruction to execute
Returns
void
Implementation of
pop()
> pop(mask, _container, instructionSet): void
Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMaskPipe.d.ts:19
Used by effect pipes to pop effects from the renderer.
Parameters
mask
_container
instructionSet
the instruction set currently being built
Returns
void
Implementation of
push()
> push(mask, _container, instructionSet): void
Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMaskPipe.d.ts:18
Used by the effect pipes push and pop effects to the renderer. A push effect allows the renderer to change its state to support the effect. A pop effect allows the renderer to return to its previous state. An example of this would be the filter effect.
Parameters
mask
_container
instructionSet
the instruction set currently being built
Returns
void