PIXI.filters.ReflectionFilter

class ReflectionFilter extends PIXI.Filter

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

See:

Constructor

new PIXI.filters.ReflectionFilter(options: object) → {}

Parameters:
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

Summary

Properties from ReflectionFilter

ReflectionFilterOptions	static defaults Default constructor options
Array<number>	alpha = [1, 1]
Array<number>	amplitude = [0, 20]
number	boundary = 0.5
boolean	mirror = true
number	time = 0 Time for animating position of waves
Array<number>	waveLength = [30, 100]

Properties inherited from Filter

boolean	autoFit = true
PIXI.BLEND_MODES	blendMode = PIXI.BLEND_MODES.NORMAL
boolean	enabled If enabled is true the filter is applied, if false it will not.
boolean	legacy
PIXI.MSAA_QUALITY	multisample The samples of the filter.
number	padding
number	resolution
PIXI.State	state The WebGL state the filter requires to render.

Properties inherited from Shader

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

Public Properties

defaults ReflectionFilter.ts:30

static defaults: ReflectionFilterOptions

Default constructor options

alpha ReflectionFilter.ts:135

alpha: Array<number> = [1, 1]

Starting and ending alpha values

amplitude ReflectionFilter.ts:105

amplitude: Array<number> = [0, 20]

Starting and ending amplitude of waves

boundary ReflectionFilter.ts:91

boundary: number = 0.5

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

mirror ReflectionFilter.ts:78

mirror: boolean = true

true to reflect the image, false for waves-only

time ReflectionFilter.ts:40

time: number = 0

Time for animating position of waves

waveLength ReflectionFilter.ts:120

waveLength: Array<number> = [30, 100]

Starting and ending length of waves