Class: ShockwaveFilter

ShockwaveFilter

The ShockwaveFilter class lets you apply a shockwave effect.
originalfilter

new ShockwaveFilter (center, options, time)

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.

See:

Extends

  • PIXI.Filter

Members

ShockwaveFilter.defaults ShockwaveFilterOptions staticreadonly

Default constructor options.

amplitude number

The amplitude of the shockwave.

brightness number

The brightness of the shockwave.

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 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.