Taos API Reference
    Preparing search index...

    Class ForwardOverlayFeature

    Hybrid forward overlay used by deferred pipelines to draw transparent meshes on top of the lit deferred result. Loads frame.hdr and the frame.gbuffer.depth (so transparents depth-test against opaque) and writes back into frame.hdr. Reads frame.transparent.

    Two backends are supported (see ForwardOverlayFeatureOptions.plus):

    • forward (default) — ForwardPass, a single render pass with a fixed per-fragment light loop. Cheap for a handful of point/spot lights.
    • forward+ — ForwardPlusPass, runs a tile-cull compute then a shading pass that walks only the lights its tile owns. Pays for itself once point lights are dense enough that the fixed loop is the bottleneck. Spot lights are not tile-culled by this backend.

    Implements

    Index

    Constructors

    constructor

    Properties

    name enabled pass plusPass ibl

    Methods

    setIbl setup update addPasses destroy

    Constructors

    Properties

    name: string = ForwardOverlayFeature.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: ForwardPass | null = null

    Active backend pass — exactly one of these is non-null after setup.

    plusPass: ForwardPlusPass | null = null
    ibl: IblTextures | undefined

    Environment IBL the overlay reflects; mirrors the deferred path's IBL so forward/transparent surfaces reflect the same environment.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods