Taos API Reference
    Preparing search index...

    Interface PointSpotLightFeatureOptions

    interface PointSpotLightFeatureOptions {
        pointLights?: () => readonly PointLight[];
        spotLights?: () => readonly SpotLight[];
        areaLights?: () => readonly AreaLight[];
        culling?: PointSpotCulling;
        autoCulled?: AutoCulledMode;
        areaLightLtc?: boolean;
    }
    Index

    Properties

    pointLights? spotLights? areaLights? culling? autoCulled? areaLightLtc?

    Properties

    pointLights?: () => readonly PointLight[]

    Override the point-light list. Default = scene.getComponents(PointLight).

    spotLights?: () => readonly SpotLight[]

    Override the spot-light list. Default = scene.getComponents(SpotLight).

    areaLights?: () => readonly AreaLight[]

    Representative-point area lights (sphere / tube / rect) — additively blended with the point/spot contribution.

    culling?: PointSpotCulling

    Light-culling strategy. 'none' always brute-forces every light per pixel (cheapest for a handful of lights); 'tiled' / 'clustered' always run the respective cull compute pre-pass (scale to hundreds of lights); 'auto' (default) picks brute-vs-culled per-frame from the live light count with hysteresis. See selectCulling.

    autoCulled?: AutoCulledMode

    Which culled strategy 'auto' escalates to once the light count is high. Default 'tiled' (finer lateral granularity — better for many small lights spread across the screen); choose 'clustered' for scenes with large depth range / strong near–far discontinuities. Ignored unless culling is 'auto'.

    areaLightLtc?: boolean

    When true, rect area lights are shaded with reference-quality Linearly Transformed Cosines instead of the representative-point approximation (sphere/tube unaffected). Opt-in (default false): compiles the LTC shader variant for all cull modes + uploads two small vendored fit tables. Toggle live with setAreaLightLtc. See TODO/ltc-area-lights.md.

    Settings

    Member Visibility

    On This Page

    Properties