Taos API Reference
    Preparing search index...

    Class ForwardPlusFeature

    Tiled forward+ pass — wraps ForwardPlusPass. Reads frame.opaque + frame.transparent for draws (transparents shade after opaques, depth-tested but not depth-written), optional frame.shadowMap + cascades for the directional sun, and the caller-supplied many-light list. Loads frame.hdr if set, otherwise clears.

    Implements

    Index

    Constructors

    Properties

    name: string = ForwardPlusFeature.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: ForwardPlusPass | null = null
    debugMode: number = 0

    G-buffer-style channel visualization (0 = off / lit), matching the deferred debugMode numbering. Mirrors ForwardPlusPass.debugMode; applied each frame. Lets the same channel be inspected in the forward as in the deferred path.

    Light-culling strategy applied to the pass each frame. Mirrors ForwardPlusPass.cullMode; defaults to the option passed at construction.

    enableAerial: boolean = false

    Enable the aerial-perspective haze. Opt-in — defaults false so existing forward+ scenes that never had aerial are unaffected; set true (and supply matching params via the pass) to turn it on. Applied each frame.

    contactShadows: ContactShadowParams | null = null

    Screen-space contact shadows for the sun (null = off, the default). Enabling forces the opaque depth pre-pass to run. Mutable at runtime; applied each frame. See ForwardPlusPass.setContactShadows.

    shadowVsmBlur: number

    EVSM2 moment-map blur radius in texels. Mutable at runtime.

    shadowVsmBleed: number

    EVSM2 light-bleed reduction [0,1). Mutable at runtime.

    Methods

    • Toggle the LTC rect-area-light path live (no pass rebuild). Only effective when the feature was constructed with areaLightLtc: true; otherwise a no-op. When off, rect area lights fall back to representative-point shading.

      Parameters

      • enabled: boolean

      Returns void