Taos API Reference
    Preparing search index...

    Class LensFlareFeature

    Screen-space lens flare from a distant sun, wrapping LensFlarePass. Each frame it projects the sun to screen space (using the render camera), zeroes the flare when the sun is behind the camera, and lets the pass occlude it against scene depth. Reads frame.hdr + frame.depth, writes frame.hdr. Register AFTER the sky/lighting features and BEFORE tonemap.

    Implements

    Index

    Constructors

    constructor

    Properties

    name enabled pass color intensity

    Methods

    setup update addPasses destroy

    Constructors

    Properties

    name: string = LensFlareFeature.name

    Stable identifier used for lookup, signature hashing, and pass-name keying.

    enabled: boolean = true

    When false, the feature is skipped each frame. Toggling triggers a cached-graph invalidation.

    pass: LensFlarePass | null = null
    color: { x: number; y: number; z: number }

    Linear-RGB tint of the sun core / streak. Mutable at runtime.

    intensity: number

    Overall flare strength. Mutable at runtime (read each frame in update).

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods