Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGodRaysEffectDefinition

Hierarchy

Index

Properties

Properties

type

type: GOD_RAYS

The type of this effect.

Optional properties

properties?: { blendFunction?: BlendFunction; blur?: boolean; clampMax?: number; decay?: number; density?: number; exposure?: number; kernelSize?: KernelSize; weight?: number }

Type declaration

  • Optional blendFunction?: BlendFunction

    The blend function of this effect. (default: BlendFunction.SCREEN)

  • Optional blur?: boolean

    Whether the god rays should be blurred to reduce artifacts. (default: true)

  • Optional clampMax?: number

    An upper bound for the saturation of the overall effect. (default: 1.0)

  • Optional decay?: number

    An illumination decay factor. (default: 0.9)

  • Optional density?: number

    The density of the light rays. (default: 0.96)

  • Optional exposure?: number

    A constant attenuation coefficient. (default: 0.6)

  • Optional kernelSize?: KernelSize

    The blur kernel size. Has no effect if blur is disabled. (default: KernelSize.SMALL)

  • Optional weight?: number

    A light ray weight factor. (default: 0.4)

Optional token

token?: string

The token of the effect, is only returned by the viewer, but ignored as an input.