Class: CanvasFilterSystem

Defined in: node_modules/pixi.js/lib/filters/CanvasFilterSystem.d.ts:29

Canvas2D filter system that applies compatible filters using CSS filter strings. Unsupported filters are skipped with a warn-once message.

Advanced

Implements

• System

Constructors

Constructor

> new CanvasFilterSystem(renderer): CanvasFilterSystem

Defined in: node_modules/pixi.js/lib/filters/CanvasFilterSystem.d.ts:53

Parameters

renderer

The Canvas renderer

canvasContext

{ activeContext: ICanvasRenderingContext2D; activeResolution: number; }

canvasContext.activeContext

ICanvasRenderingContext2D

canvasContext.activeResolution

number

Returns

CanvasFilterSystem

Properties

renderer

> readonly renderer: object

Defined in: node_modules/pixi.js/lib/filters/CanvasFilterSystem.d.ts:36

The renderer this system is attached to

canvasContext

> canvasContext: object

canvasContext.activeContext

> activeContext: ICanvasRenderingContext2D

canvasContext.activeResolution

> activeResolution: number

Accessors

alphaMultiplier

Get Signature

> get alphaMultiplier(): number

Defined in: node_modules/pixi.js/lib/filters/CanvasFilterSystem.d.ts:86

Returns

number

Methods

destroy()

> destroy(): void

Defined in: node_modules/pixi.js/lib/filters/CanvasFilterSystem.d.ts:90

Destroys the system

Returns

void

Implementation of

System.destroy

---

generateFilteredTexture()

> generateFilteredTexture(params): Texture

Defined in: node_modules/pixi.js/lib/filters/CanvasFilterSystem.d.ts:75

Applies supported filters to a texture and returns a new texture. Unsupported filters are skipped with a warn-once message.

Parameters

params

The parameters for applying filters.

filters

Filter[]

texture

Texture

Returns

Texture

The resulting texture after filters are applied.

---

pop()

> pop(): void

Defined in: node_modules/pixi.js/lib/filters/CanvasFilterSystem.d.ts:66

Pop a filter from the stack. Called when exiting a filtered container.

Returns

void

---

push()

> push(instruction): void

Defined in: node_modules/pixi.js/lib/filters/CanvasFilterSystem.d.ts:64

Push a filter instruction onto the stack. Called when entering a filtered container.

Parameters

instruction

FilterInstruction

The filter instruction from FilterPipe

Returns

void