Class FilterEffect`Abstract`

Base class for post-processing effects on the whole screen.

Extend it and name the class with DefineFilterEffect.

See

Index

Constructors

Properties

filterEffectName

Methods

Constructors

constructor

new FilterEffect(): FilterEffect

Returns FilterEffect

Properties

`Static`filterEffectName

filterEffectName: string

The name the configuration uses for the filter effect. DefineFilterEffect sets it, so a game usually does not assign it.

Methods

`Abstract`create

create(options: unknown): Filter
Runs when the effect is added. Returns a pixi.js Filter.
Parameters
- options: unknown
Returns Filter

`Optional`update

update?(filter: Filter, options: unknown, elapsedTime: number): void
Runs every frame. Changes the filter. elapsedTime is in seconds. Optional. Without it, the filter keeps the values create gave it.
Parameters
- filter: Filter
- options: unknown
- elapsedTime: number
Returns void