PixiJS Filters

Class: ReflectionFilter

ReflectionFilter

Applies a reflection effect to simulate the reflection on water with waves.
originalfilter

new ReflectionFilter (options)

ReflectionFilter.ts:42
Name Type Attributes Default Description
options object <optional>

The optional parameters of Reflection effect.
options.mirror number <optional>
 true

true to reflect the image, false for waves-only
options.boundary number <optional>
 0.5

Vertical position of the reflection point, default is 50% (middle) smaller numbers produce a larger reflection, larger numbers produce a smaller reflection.
options.amplitude number <optional>
 [0, 20]

Starting and ending amplitude of waves
options.waveLength number <optional>
 [30, 100]

Starting and ending length of waves
options.alpha number <optional>
 [1, 1]

Starting and ending alpha values
options.time number <optional>
 0

Time for animating position of waves
See:

Extends

  • PIXI.Filter

Members

ReflectionFilter.defaults ReflectionFilterOptions staticreadonly

Default constructor options

alpha Array<number>

Starting and ending alpha values

Default Value:
  • [1, 1]

amplitude Array<number>

Starting and ending amplitude of waves

Default Value:
  • [0, 20]

boundary number

Vertical position of the reflection point, default is 50% (middle) smaller numbers produce a larger reflection, larger numbers produce a smaller reflection.

Default Value:
  • 0.5

mirror boolean

true to reflect the image, false for waves-only

Default Value:
  • true

time number

Time for animating position of waves

Default Value:
  • 0

waveLength Array<number>

Starting and ending length of waves

Default Value:
  • [30, 100]