1681-engine / postfx / ShockwaveFilter
Class: ShockwaveFilter ​
Defined in: src/postfx/ShockwaveFilter.ts:14
A ring that bends the picture as it passes: an explosion's blast, a landing's thump. Set centerX/Y (0–1 across the filtered area) and grow radius (a share of its height) over time; PostFx.shockwave does both and removes it.
Extends ​
Constructors ​
Constructor ​
new ShockwaveFilter(options?): ShockwaveFilter;Defined in: src/postfx/ShockwaveFilter.ts:15
Parameters ​
| Parameter | Type |
|---|---|
options | ShockwaveOptions |
Returns ​
ShockwaveFilter
Overrides ​
Properties ​
fxName ​
readonly fxName: string;Defined in: src/postfx/fxShader.ts:132
Inherited from ​
Accessors ​
amplitude ​
Get Signature ​
get amplitude(): number;Defined in: src/postfx/ShockwaveFilter.ts:52
Returns ​
number
Set Signature ​
set amplitude(v): void;Defined in: src/postfx/ShockwaveFilter.ts:55
Parameters ​
| Parameter | Type |
|---|---|
v | number |
Returns ​
void
radius ​
Get Signature ​
get radius(): number;Defined in: src/postfx/ShockwaveFilter.ts:46
Returns ​
number
Set Signature ​
set radius(v): void;Defined in: src/postfx/ShockwaveFilter.ts:49
Parameters ​
| Parameter | Type |
|---|---|
v | number |
Returns ​
void
Methods ​
get() ​
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() ​
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() ​
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
Inherited from ​
setCenter() ​
setCenter(x, y): void;Defined in: src/postfx/ShockwaveFilter.ts:43
Parameters ​
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns ​
void