Taos API Reference
    Preparing search index...

    Interface ForwardPresetOptions

    interface ForwardPresetOptions {
        sky?: SkyOption;
        shadow?: boolean | ShadowFeatureOptions;
        ibl?: IblTextures;
        lighting?: { useSphericalHarmonics?: boolean };
        directional?: () => DirectionalLight;
        taa?: boolean;
        aa?: false | "taa" | "smaa" | "fxaa" | "cmaa2" | "msaa" | "taau";
        msaa?: 4 | 2;
        smaa?: SMAAOptions;
        fxaa?: FXAAOptions;
        cmaa2?: CMAA2Options;
        taau?: TemporalUpscaleFeatureOptions;
        motionBlur?: boolean | MotionBlurFeatureOptions;
        dof?: boolean | DofFeatureOptions;
        bloom?: boolean | BloomFeatureOptions;
        exposure?: number;
        aces?: boolean;
        camera?: CameraExposureSettings;
        physicalSceneScale?: number;
        hdrCanvas?: boolean;
    }
    Index

    Properties

    sky? shadow? ibl? lighting? directional? taa? aa? msaa? smaa? fxaa? cmaa2? taau? motionBlur? dof? bloom? exposure? aces? camera? physicalSceneScale? hdrCanvas?

    Properties

    sky?: SkyOption

    Sky source — see SkyOption for the union. Default: no sky.

    shadow?: boolean | ShadowFeatureOptions

    Cascaded directional shadow map. Default: disabled — the forward path is used most often for material-showcase scenes that don't need cascades. Pass true for defaults, or a config object forwarded to ShadowFeature.

    ibl?: IblTextures

    IBL texture set passed to the forward-lit pass for indirect lighting.

    lighting?: { useSphericalHarmonics?: boolean }

    Forward-lit tuning. useSphericalHarmonics selects the IBL_DIFFUSE_SH variant (diffuse IBL from order-3 SH coefficients instead of the irradiance cube); it's a pipeline-build-time choice, so it must be set here.

    directional?: () => DirectionalLight

    Override the directional light supplied to the forward pass; otherwise the scene's first DirectionalLight component is used.

    taa?: boolean

    Temporal anti-aliasing. Default: false (kept off so the minimal sample stays minimal; turn on per-sample). Ignored when aa is set.

    aa?: false | "taa" | "smaa" | "fxaa" | "cmaa2" | "msaa" | "taau"

    Anti-aliasing method, a superset of taa that also selects SMAA:

    • 'taa' — temporal AA (TAAFeature).
    • 'smaa' — spatial SMAA 1x (SMAAFeature); no jitter/history/ghosting.
    • 'fxaa' — FXAA 3.11 (FXAAFeature); cheapest spatial option.
    • 'cmaa2' — CMAA2 (CMAA2Feature); compute-based conservative morphological AA, no jitter/history/ghosting.
    • 'msaa' — hardware MSAA in the forward pass (see msaa). The highest geometric-edge quality, but only smooths geometry edges, costs bandwidth, requires no pre-HDR sky (sky: undefined), and disables depth-based post (DoF). Forward-only — unavailable in the deferred path.
    • 'taau' — temporal upscaler (TemporalUpscaleFeature, FSR2-style); renders sub-native and resolves to display res. Tune via taau.
    • false — no anti-aliasing. When omitted, falls back to taa (default off).
    msaa?: 4 | 2

    MSAA sample count when aa: 'msaa' — 2 or 4. Default 4.

    smaa?: SMAAOptions

    Tuning forwarded to SMAAFeature when aa: 'smaa'.

    fxaa?: FXAAOptions

    Tuning forwarded to FXAAFeature when aa: 'fxaa'.

    cmaa2?: CMAA2Options

    Tuning forwarded to CMAA2Feature when aa: 'cmaa2'.

    taau?: TemporalUpscaleFeatureOptions

    Tuning forwarded to TemporalUpscaleFeature when aa: 'taau'.

    motionBlur?: boolean | MotionBlurFeatureOptions

    Motion blur. Camera-only by default; pass { useVelocityBuffer: true } to add per-object motion blur via an extra velocity-buffer pass. Slotted after TAA and before DoF / bloom. Default: disabled.

    dof?: boolean | DofFeatureOptions
    bloom?: boolean | BloomFeatureOptions
    exposure?: number
    aces?: boolean
    camera?: CameraExposureSettings

    Drive the tonemap exposure from a physical camera (aperture/shutter/ISO → EV100) instead of exposure. See TonemapFeature.

    physicalSceneScale?: number

    Calibration for camera on a still-normalized scene (default 1).

    hdrCanvas?: boolean

    Settings

    Member Visibility

    On This Page

    Properties