1681-engine / postfx / FxFilter
Class: FxFilter ​
Defined in: src/postfx/fxShader.ts:131
A full-screen effect built from an FxShaderSpec: a Pixi Filter whose uniforms are read and written by name (fx.set('strength', 0.5), or the subclasses' own properties). Works on both renderers.
Extends ​
Filter
Extended by ​
VignetteFilterChromaticAberrationFilterPixelateFilterCrtFilterColorAdjustFilterShockwaveFilterBloomFilter
Constructors ​
Constructor ​
ts
new FxFilter(spec): FxFilter;Defined in: src/postfx/fxShader.ts:135
Parameters ​
| Parameter | Type |
|---|---|
spec | FxShaderSpec |
Returns ​
FxFilter
Overrides ​
ts
Filter.constructorProperties ​
fxName ​
ts
readonly fxName: string;Defined in: src/postfx/fxShader.ts:132
Methods ​
get() ​
ts
get(name): number | Float32Array<ArrayBufferLike>;Defined in: src/postfx/fxShader.ts:153
A uniform's value (a number, or the live array of a vector).
Parameters ​
| Parameter | Type |
|---|---|
name | string |
Returns ​
number | Float32Array<ArrayBufferLike>
num() ​
ts
protected num(name): number;Defined in: src/postfx/fxShader.ts:169
A number uniform, for the subclasses' getters.
Parameters ​
| Parameter | Type |
|---|---|
name | string |
Returns ​
number
set() ​
ts
set(name, ...values): this;Defined in: src/postfx/fxShader.ts:158
Sets a number uniform, or the components of a vector one.
Parameters ​
| Parameter | Type |
|---|---|
name | string |
...values | number[] |
Returns ​
this