Interface: GodrayFilterOptions

GodrayFilterOptions

Options for the GodrayFilter constructor.

Properties:
Name Type Default Description
alpha number 1

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

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 PointData | number[] {x:0,y:0}

Focal point for non-parallel rays, to use this parallel must be set to false. This should be a size 2 array or an object containing x and y values, you cannot change types once defined in the constructor

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 number 2.5

The density of the fractal noise

parallel boolean true

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

time number 0

The current time position

Members

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 | number[]

Focal point for non-parallel rays, to use this parallel must be set to false. This should be a size 2 array or an object containing x and y values, you cannot change types once defined in the constructor

Default Value:
  • {x:0,y: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

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