Viewer
    Preparing search index...

    Interface IVignetteEffectDefinition

    interface IVignetteEffectDefinition {
        type: VIGNETTE;
        properties?: {
            blendFunction?: number;
            darkness?: number;
            offset?: number;
            technique?: number;
        };
        token?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    type properties? token?

    Properties

    type: VIGNETTE

    The type of this effect.

    properties?: {
        blendFunction?: number;
        darkness?: number;
        offset?: number;
        technique?: number;
    }

    Type Declaration

    • OptionalblendFunction?: number

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

    • Optionaldarkness?: number

      The Vignette darkness. (default: 0.5)

    • Optionaloffset?: number

      The Vignette offset. (default: 0.5)

    • Optionaltechnique?: number

      The Vignette technique. (default: VignetteTechnique.DEFAULT)

    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