Hilo3d API - v2.0.0-alpha.4
    Preparing search index...

    Interface VolumetricLightingOptions

    Production controls for WebGPU Clustered Forward+ froxel volumetric lighting.

    interface VolumetricLightingOptions {
        albedo?: Readonly<Color>;
        ambientStrength?: number;
        anisotropy?: number;
        baseHeight?: number;
        debugView?: VolumetricLightingDebugView;
        density?: number;
        depthThreshold?: number;
        heightFalloff?: number;
        historyWeight?: number;
        jitterStrength?: number;
        localVolumes?: readonly VolumetricFogVolume[];
        maxDistance?: number;
        quality?: VolumetricLightingQuality;
        resolutionScale?: number;
        shadowSteps?: number;
    }
    Index
    albedo? ambientStrength? anisotropy? baseHeight? debugView? density? depthThreshold? heightFalloff? historyWeight? jitterStrength? localVolumes? maxDistance? quality? resolutionScale? shadowSteps?
    albedo?: Readonly<Color>

    Global single-scattering albedo. Defaults to a cool neutral white.

    ambientStrength?: number

    Ambient light injected into the medium. Defaults to 0.12.

    anisotropy?: number

    Henyey-Greenstein anisotropy in [-0.9, 0.9]. Positive values emphasize forward scatter.

    baseHeight?: number

    World-space height at and below which global density is constant. Defaults to 0.

    debugView?: VolumetricLightingDebugView

    Replace normal composition with an integrated radiance or extinction diagnostic.

    density?: number

    Global extinction density in inverse world units. Defaults to 0.025.

    depthThreshold?: number

    Maximum relative scene-depth disagreement accepted during reprojection. Defaults to 0.04.

    heightFalloff?: number

    Exponential density falloff above baseHeight. Defaults to 0.12.

    historyWeight?: number

    Maximum temporal history contribution in [0, 0.98]. Defaults to 0.9.

    jitterStrength?: number

    Sub-froxel stochastic sample offset strength in [0, 1]. Defaults to 1.

    localVolumes?: readonly VolumetricFogVolume[]

    Optional world-space local fog volumes, limited to 32.

    maxDistance?: number

    Maximum integrated view distance in world units. Defaults to 120.

    quality?: VolumetricLightingQuality

    Preset used for unspecified reconstruction and shadow budgets. Defaults to high.

    resolutionScale?: number

    Froxel XY and reconstruction resolution relative to the internal scene. Defaults to the preset.

    shadowSteps?: number

    Depth-aware screen-space light visibility samples in [0, 8]. Defaults to the preset.

    Settings
    Member Visibility

    On This Page
    Properties