Viewer
    Preparing search index...

    Interface ISelectiveBloomEffectDefinition

    interface ISelectiveBloomEffectDefinition {
        type: SELECTIVE_BLOOM;
        properties?: {
            blendFunction?: number;
            ignoreBackground?: boolean;
            intensity?: number;
            kernelSize?: number;
            luminanceSmoothing?: number;
            luminanceThreshold?: number;
            mipmapBlur?: boolean;
        };
        token?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    type properties? token?

    Properties

    type: SELECTIVE_BLOOM

    The type of this effect.

    properties?: {
        blendFunction?: number;
        ignoreBackground?: boolean;
        intensity?: number;
        kernelSize?: number;
        luminanceSmoothing?: number;
        luminanceThreshold?: number;
        mipmapBlur?: boolean;
    }

    Type Declaration

    • OptionalblendFunction?: number

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

    • OptionalignoreBackground?: boolean

      Enables or disables if the background is evaluated for the bloom calculation. (default: true)

    • Optionalintensity?: number

      The bloom intensity. (default: 1.0)

    • OptionalkernelSize?: number

      The blur kernel size. (default: KernelSize.LARGE)

    • OptionalluminanceSmoothing?: number

      Controls the smoothness of the luminance threshold. Range is [0, 1]. (default: 0.025)

    • OptionalluminanceThreshold?: number

      The luminance threshold. Raise this value to mask out darker elements in the scene. Range is [0, 1]. (default: 0.9)

    • OptionalmipmapBlur?: boolean

      Enables or disables mipmap blur. (default: false)

    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