Engine API Reference - v2.24.0-beta.16
    Preparing search index...

    Interface LensFlareElementDesc

    interface LensFlareElementDesc {
        aspect?: number;
        autoRotate?: boolean;
        color?: number[] | Color;
        count?: number;
        intensity?: number;
        offset?: number;
        rotation?: number;
        shape: string;
        size?: number;
        spread?: number;
    }
    Index
    aspect?: number

    The width of the element relative to its height. Defaults to 1.

    autoRotate?: boolean

    Whether the element is rotated to align with the axis, for streaks. Defaults to false.

    color?: number[] | Color

    The colour of the element, as a Color or an array of three numbers. Defaults to white.

    count?: number

    The number of copies of the element, spread along the axis around its offset - a train of ghosts. Defaults to 1.

    intensity?: number

    The brightness of the element. Defaults to 1.

    offset?: number

    The position along the axis: 0 at the source, 1 at the centre of the screen, 2 mirrored across the centre, negative beyond the source. Defaults to 0.

    rotation?: number

    The rotation of the element, in degrees. Defaults to 0.

    shape: string

    The name of the shape, in the shape library of the LensFlareEffect the flare is added to.

    size?: number

    The height of the element, as a fraction of the screen height. Defaults to 0.1.

    spread?: number

    The distance along the axis the copies are spread over, in the units of the offset. Defaults to 0.