Cluster Creator Kit Script Reference
    Preparing search index...

    Interface VignetteSettingsItem Beta

    The configuration values for the post-process Vignette effect.

    interface VignetteSettings {
        active: boolean;
        center: PostProcessVector2Property;
        color: PostProcessColorProperty;
        enabled: PostProcessBoolProperty;
        intensity: PostProcessFloatProperty;
        rounded: PostProcessBoolProperty;
        roundness: PostProcessFloatProperty;
        smoothness: PostProcessFloatProperty;
    }
    Index

    Properties

    active center color enabled intensity rounded roundness smoothness

    Properties

    active: boolean
    center: PostProcessVector2Property

    Sets the center of the Vignette effect. It is represented in a coordinate system where the bottom left of the screen is (0, 0) and the top right is (1, 1). To set the center of the screen as the center of the effect, please set it to (0.5, 0.5).

    color: PostProcessColorProperty

    Sets the color for the Vignette effect.

    enabled: PostProcessBoolProperty
    intensity: PostProcessFloatProperty

    Sets the intensity of the Vignette effect. The specified value is clamped between 0 and 1.

    rounded: PostProcessBoolProperty

    Sets whether Vignette effect is rounded.

    roundness: PostProcessFloatProperty

    Sets the roundness of the Vignette effect. The specified value is clamped between 0 and 1.

    smoothness: PostProcessFloatProperty

    Sets the smoothness of the Vignette effect. The specified value is clamped between 0.01 and 1.

    Settings

    Member Visibility

    On This Page

    Properties