PIXI.filters.GodrayFilter

class GodrayFilter extends PIXI.Filter

GordayFilter, originally by Alain Galvan

original filter


  displayObject.filters = [new GodrayFilter()];

See:

Constructor

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

Parameters:
Name	Type	Attributes	Default	Description
options	object	<optional>		Filter options
options.angle	number	<optional>	30	Angle/Light-source of the rays.
options.gain	number	<optional>	0.5	General intensity of the effect.
options.lacunarity	number	<optional>	2.5	The density of the fractal noise.
options.parallel	boolean	<optional>	true	`true` to use `angle`, `false` to use `center`
options.time	number	<optional>	0	The current time position.
options.center	PIXI.Point \| number<Array>	<optional>	[0,0]	Focal point for non-parallel rays, to use this `parallel` must be set to `false`.
options.alpha	number	<optional>	1.0	the alpha, defaults to 1, affects transparency of rays

GodrayFilterOptions	static defaults Default for constructior options.
number	alpha = 1
number	angle = 30
number[] \| PIXI.Point	center
number	gain = 0.5
number	lacunarity = 2.5
boolean	parallel = true
number	time = 0 The current time.

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.

PIXI.Program

program

Program that the shader uses.

Dict<any>

uniforms

defaults GodrayFilter.ts:37

static defaults: GodrayFilterOptions

Default for constructior options.

alpha GodrayFilter.ts:166

alpha: number = 1

The alpha (opacity) of the rays. 0 is fully transparent, 1 is fully opaque.

angle GodrayFilter.ts:119

angle: number = 30

The angle/light-source of the rays in degrees. For instance, a value of 0 is vertical rays, values of 90 or -90 produce horizontal rays.

center GodrayFilter.ts:54

center: number[] | PIXI.Point

The position of the emitting point for light rays only used if parallel is set to false.

gain GodrayFilter.ts:138

gain: number = 0.5

General intensity of the effect. A value closer to 1 will produce a more intense effect, where a value closer to 0 will produce a subtler effect.

lacunarity GodrayFilter.ts:152

lacunarity: number = 2.5

The density of the fractal noise. A higher amount produces more rays and a smaller amound produces fewer waves.

parallel GodrayFilter.ts:48

parallel: boolean = true

true if light rays are parallel (uses angle), false to use the focal center point

time GodrayFilter.ts:60

time: number = 0

The current time.