Taos API Reference
    Preparing search index...

    Class VxgiFeature

    Voxel-cone-traced global illumination feature.

    A world-space alternative to SsgiFeature: each frame it voxelizes the opaque scene geometry (3-axis rasterization, camera-independent), lighting each voxel with the scene's lights + emissive, then gathers multi-bounce diffuse indirect by anisotropic cone tracing — temporally accumulated and edge-aware blurred. The result is published on frame.ssgi (the buffer DeferredLightingFeature consumes as the indirect-diffuse term), so it is mutually exclusive with SSGI.

    Unlike the earlier screen-space-injection prototype, voxelization covers ALL surfaces (not just visible ones), so the GI is view-independent and bounces off-screen light. Must be registered AFTER a geometry feature (it needs frame.gbuffer for the cone trace) and BEFORE DeferredLightingFeature. The deferredPreset vxgi option places it in the correct slot.

    Implements

    Index

    Constructors

    Properties

    name: string = VxgiFeature.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: VXGIPass | null = null
    ddgiPass: DDGIPass | null = null

    DDGI output-stage pass, present only when the ddgi option is set.

    settings: Partial<VXGISettings>
    requireVolume: boolean

    When true, GI is produced only if the scene has an enabled VoxelGiVolume.

    Methods