Viewer
    Preparing search index...

    Interface IGodRaysEffectDefinition

    interface IGodRaysEffectDefinition {
        type: GOD_RAYS;
        properties?: {
            blendFunction?: number;
            blur?: boolean;
            clampMax?: number;
            decay?: number;
            density?: number;
            exposure?: number;
            kernelSize?: number;
            weight?: number;
        };
        token?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    type properties? token?

    Properties

    type: GOD_RAYS

    The type of this effect.

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

    Type Declaration

    • OptionalblendFunction?: number

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

    • Optionalblur?: boolean

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

    • OptionalclampMax?: number

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

    • Optionaldecay?: number

      An illumination decay factor. (default: 0.9)

    • Optionaldensity?: number

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

    • Optionalexposure?: number

      A constant attenuation coefficient. (default: 0.6)

    • OptionalkernelSize?: number

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

    • Optionalweight?: number

      A light ray weight factor. (default: 0.4)

    token?: string

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

    Settings

    Member Visibility

    On This Page

    Properties