Engine API Reference - v2.7.4
    Preparing search index...

    Interface Vignette

    Properties related to the vignette effect, a postprocessing technique that darkens the image edges, creating a gradual falloff in brightness from the center outward. The effect can be also reversed, making the center of the image darker than the edges, by specifying the outer distance smaller than the inner distance.

    interface Vignette {
        curvature: number;
        inner: number;
        intensity: number;
        outer: number;
    }
    Index

    Properties

    curvature: number

    The curvature of the vignette effect, 0.01-10 range. The vignette is rendered using a rectangle with rounded corners, and this parameter controls the curvature of the corners. Value of 1 represents a circle. Smaller values make the corners more square, while larger values make them more rounded. Defaults to 0.5.

    inner: number

    The inner distance of the vignette effect measured from the center of the screen, 0-3 range. This is where the vignette effect starts. Value larger than 1 represents the value off screen, which allows more control. Defaults to 0.5, representing half the distance from center.

    intensity: number

    The intensity of the vignette effect, 0-1 range. Defaults to 0, making it disabled.

    outer: number

    The outer distance of the vignette effect measured from the center of the screen, 0-3 range. This is where the vignette reaches full intensity. Value larger than 1 represents the value off screen, which allows more control. Defaults to 1, representing the full screen.