PixiJS Filters

Class: ShockwaveFilter

PIXI.filters~ShockwaveFilter

The ShockwaveFilter class lets you apply a shockwave effect.
originalfilter

new ShockwaveFilter (center, options, time)

ShockwaveFilter.js:26
Name Type Default Description
center PIXI.Point | Array.<number> [0.5, 0.5] optional

See center property.
options object optional

The optional parameters of shockwave filter.

Name Type Default Description
amplitude number 0.5 optional

See `amplitude`` property.
wavelength number 1.0 optional

See wavelength property.
speed number 500.0 optional

See speed property.
brightness number 8 optional

See brightness property.
radius number 4 optional

See radius property.
time number 0 optional

See time property.
See:

Extends

  • PIXI.Filter

Members

amplitude number

The amplitude of the shockwave.

brightness number

The brightness of the shockwave.

center PIXI.Point | Array.<number>

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 number

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

speed number

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

time number

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

wavelength number

The wavelength of the shockwave.