Pixi’VNClass: FilterPipe
Defined in: node_modules/pixi.js/lib/filters/FilterPipe.d.ts:9
Internal
Implements
Constructors
Constructor
> new FilterPipe(renderer): FilterPipe
Defined in: node_modules/pixi.js/lib/filters/FilterPipe.d.ts:15
Parameters
renderer
Returns
FilterPipe
Properties
extension
> static extension: object
Defined in: node_modules/pixi.js/lib/filters/FilterPipe.d.ts:10
name
> readonly name: "filter"
type
> readonly type: readonly [WebGLPipes, WebGPUPipes, CanvasPipes]
Methods
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/filters/FilterPipe.d.ts:19
Returns
void
execute()
> execute(instruction): void
Defined in: node_modules/pixi.js/lib/filters/FilterPipe.d.ts:18
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(_filterEffect, _container, instructionSet): void
Defined in: node_modules/pixi.js/lib/filters/FilterPipe.d.ts:17
Used by effect pipes to pop effects from the renderer.
Parameters
_filterEffect
_container
instructionSet
the instruction set currently being built
Returns
void
Implementation of
push()
> push(filterEffect, container, instructionSet): void
Defined in: node_modules/pixi.js/lib/filters/FilterPipe.d.ts:16
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
filterEffect
container
instructionSet
the instruction set currently being built
Returns
void