1681-engine / postfx / VignetteFilter
Class: VignetteFilter ​
Defined in: src/postfx/VignetteFilter.ts:15
Darkens the edges of the screen towards a colour, round whatever its shape.
Extends ​
Constructors ​
Constructor ​
ts
new VignetteFilter(options?): VignetteFilter;Defined in: src/postfx/VignetteFilter.ts:16
Parameters ​
| Parameter | Type |
|---|---|
options | VignetteOptions |
Returns ​
VignetteFilter
Overrides ​
Properties ​
fxName ​
ts
readonly fxName: string;Defined in: src/postfx/fxShader.ts:132
Inherited from ​
Accessors ​
color ​
Set Signature ​
ts
set color(c): void;Defined in: src/postfx/VignetteFilter.ts:45
Parameters ​
| Parameter | Type |
|---|---|
c | number |
Returns ​
void
strength ​
Get Signature ​
ts
get strength(): number;Defined in: src/postfx/VignetteFilter.ts:38
Returns ​
number
Set Signature ​
ts
set strength(v): void;Defined in: src/postfx/VignetteFilter.ts:41
Parameters ​
| Parameter | Type |
|---|---|
v | number |
Returns ​
void
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>
Inherited from ​
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
Inherited from ​
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