PixiJS Filters

Class: GodrayFilter

GodrayFilter

GordayFilter, originally by Alain Galvan

originalfilter

new GodrayFilter (options)

Name Type Attributes Description
options GodrayFilterOptions <optional>

Options for the GodrayFilter constructor.

Example

displayObject.filters = [new GodrayFilter()];

Extends

  • Filter

Members

DEFAULT_OPTIONS GodrayFilterOptions staticreadonly

Default values for options.

alpha number

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

Default Value:
  • 1

angle number

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

center PointData

Focal point for non-parallel rays, to use this parallel must be set to false.

Default Value:
  • {x:0,y:0}

centerX number

Focal point for non-parallel rays on the x axis, to use this parallel must be set to false.

Default Value:
  • 0

centerY number

Focal point for non-parallel rays on the y axis, to use this parallel must be set to false.

Default Value:
  • 0

gain number

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

lacunarity number

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

Default Value:
  • 2.5

parallel boolean

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

Default Value:
  • true

time number

The current time position

Default Value:
  • 0