PixiJS Filters

Class: ReflectionFilter

ReflectionFilter

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

new ReflectionFilter (options)

Name Type Attributes Description
options ReflectionFilterOptions <optional>

Options for the ReflectionFilter constructor.

Extends

  • Filter

Members

DEFAULT_OPTIONS ReflectionFilterOptions staticreadonly

Default values for options.

alpha Range

Starting and ending alpha values

Default Value:
  • [1,1]

alphaEnd number

Starting wavelength of waves

Default Value:
  • 1

alphaStart number

Starting wavelength of waves

Default Value:
  • 1

amplitude Range

Starting and ending amplitude of waves

Default Value:
  • [0,20]

amplitudeEnd number

Starting amplitude of waves

Default Value:
  • 20

amplitudeStart number

Starting amplitude of waves

Default Value:
  • 0

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 Range

Starting and ending length of waves

Default Value:
  • [30,100]

wavelengthEnd number

Starting wavelength of waves

Default Value:
  • 100

wavelengthStart number

Starting wavelength of waves

Default Value:
  • 30