| 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 |
|
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 |
options.alpha |
number |
<optional> |
1.0 |
the alpha, defaults to 1, affects transparency of rays |
Example
displayObject.filters = [new GodrayFilter()];
Extends
- PIXI.Filter
Members
Default for constructior options.
The alpha (opacity) of the rays. 0 is fully transparent, 1 is fully opaque.
- Default Value:
- 1
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.
- Default Value:
- 30
The position of the emitting point for light rays
only used if parallel is set to false.
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.
- Default Value:
- 0.5
The density of the fractal noise. A higher amount produces more rays and a smaller amound produces fewer waves.
- Default Value:
- 2.5
true if light rays are parallel (uses angle),
false to use the focal center point
- Default Value:
- true
The current time.
- Default Value:
- 0