PIXI.filters.ShockwaveFilter

class ShockwaveFilter extends PIXI.Filter

The ShockwaveFilter class lets you apply a shockwave effect.
original filter

See:

Constructor

new PIXI.filters.ShockwaveFilter(center: PIXI.Point | number<Array>, options: object, time: number) → {}

Parameters:
Name	Type	Attributes	Default	Description
center	PIXI.Point \| number<Array>	<optional>	[0.5, 0.5]	See `center` property.
options	object	<optional>		The optional parameters of shockwave filter.
options.amplitude	number	<optional>	0.5	See `amplitude`` property.
options.wavelength	number	<optional>	1.0	See `wavelength` property.
options.speed	number	<optional>	500.0	See `speed` property.
options.brightness	number	<optional>	8	See `brightness` property.
options.radius	number	<optional>	4	See `radius` property.
time	number	<optional>	0	See `time` property.

ShockwaveFilterOptions	static defaults Default constructor options.
number	amplitude The amplitude of the shockwave.
number	brightness The brightness of the shockwave.
PIXI.Point \| number<Array>	center
number	radius
number	speed
number	time
number	wavelength The wavelength of the shockwave.

boolean	autoFit = true
PIXI.BLEND_MODES	blendMode = PIXI.BLEND_MODES.NORMAL
boolean	enabled If enabled is true the filter is applied, if false it will not.
boolean	legacy
PIXI.MSAA_QUALITY	multisample The samples of the filter.
number	padding
number	resolution
PIXI.State	state The WebGL state the filter requires to render.

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

void	apply(filterManager: PIXI.FilterSystem, input: PIXI.RenderTexture, output: PIXI.RenderTexture, clearMode: PIXI.CLEAR_MODES, _currentState: object)

defaults ShockwaveFilter.ts:30

static defaults: ShockwaveFilterOptions

Default constructor options.

amplitude ShockwaveFilter.ts:88

amplitude: number

The amplitude of the shockwave.

brightness ShockwaveFilter.ts:112

brightness: number

The brightness of the shockwave.

center ShockwaveFilter.ts:73

center: PIXI.Point | number<Array>

Sets the center of the shockwave in normalized screen coords. That is (0,0) is the top-left and (1,1) is the bottom right.

radius ShockwaveFilter.ts:137

radius: number

The maximum radius of shockwave. < 0.0 means it's infinity.

speed ShockwaveFilter.ts:124

speed: number

The speed about the shockwave ripples out. The unit is pixel/second

time ShockwaveFilter.ts:39

time: number

Sets the elapsed time of the shockwave. It could control the current size of shockwave.

wavelength ShockwaveFilter.ts:100

wavelength: number

The wavelength of the shockwave.