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

    Interface LensFlareOptions

    interface LensFlareOptions {
        direction?: Vec3;
        light?: LightComponent;
        node?: GraphNode;
        position?: Vec3;
    }
    Index
    direction? light? node? position?
    direction?: Vec3

    The world direction towards the source, for a source infinitely far away, when the flare has no light.

    light?: LightComponent

    The light the flare belongs to. A directional light gives the direction of the source, an omni or spot light its position, and a spot light also limits the flare to its cone. The colour of the light tints the flare, and its intensity scales it, see LensFlare#useLightColor and LensFlare#useLightIntensity.

    node?: GraphNode

    The node whose position is the source, when the flare has no light.

    position?: Vec3

    The world position of the source, when the flare has neither a light nor a node.

    Settings
    Member Visibility

    On This Page
    Properties