PixiJS Filters

Class: ReflectionFilter

PIXI.filters~ReflectionFilter

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

new ReflectionFilter (options)

ReflectionFilter.js:25
Name Type Description
options object optional

The optional parameters of Reflection effect.

Name Type Default Description
mirror number true optional

true to reflect the image, false for waves-only
boundary number 0.5 optional

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

Starting and ending amplitude of waves
waveLength number [30, 100] optional

Starting and ending length of waves
alpha number [1, 1] optional

Starting and ending alpha values
time number 0 optional

Time for animating position of waves
See:

Extends

  • PIXI.Filter

Members

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]