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

    Interface ClusteredForwardPlusPipelineOptions

    Construction options for the WebGPU high-end GPU Scene and Clustered Forward+ pipeline.

    interface ClusteredForwardPlusPipelineOptions {
        atmosphere?: false | Readonly<AtmosphereWeatherOptions>;
        autoExposure?: false | Readonly<AutoExposureOptions>;
        bloomStrength?: number;
        buckets: readonly GPUSceneBucket[];
        exposure?: number;
        groundTruthAmbientOcclusion?:
            | false
            | Readonly<GroundTruthAmbientOcclusionOptions>;
        hiZ?: boolean;
        maxLightIndices?: number;
        maxLights?: number;
        maxLightsPerCluster?: number;
        maxObjects?: number;
        maxViewportHeight?: number;
        maxViewportWidth?: number;
        screenSpaceGlobalIllumination?:
            | false
            | Readonly<ScreenSpaceGlobalIlluminationOptions>;
        screenSpaceReflections?: false | Readonly<ScreenSpaceReflectionsOptions>;
        temporalAA?: false | Readonly<TemporalAAOptions>;
        tileSize?: number;
        toneMapping?: "aces" | "filmic";
        variantManifest?: Readonly<ClusteredMaterialVariantManifest>;
        volumetricLighting?: false | Readonly<VolumetricLightingOptions>;
        zSlices?: number;
    }
    Index
    atmosphere? autoExposure? bloomStrength? buckets exposure? groundTruthAmbientOcclusion? hiZ? maxLightIndices? maxLights? maxLightsPerCluster? maxObjects? maxViewportHeight? maxViewportWidth? screenSpaceGlobalIllumination? screenSpaceReflections? temporalAA? tileSize? toneMapping? variantManifest? volumetricLighting? zSlices?
    atmosphere?: false | Readonly<AtmosphereWeatherOptions>

    Physical Rayleigh/Mie/ozone atmosphere, aerial perspective, procedural volumetric clouds, and cloud shadows. Disabled by default.

    autoExposure?: false | Readonly<AutoExposureOptions>

    GPU luminance histogram and temporal eye adaptation. Disabled by default.

    bloomStrength?: number

    Bloom contribution mixed into the final display transform. Defaults to 0.7.

    buckets: readonly GPUSceneBucket[]

    GPU Scene bucket families. Compatible opaque and alpha-masked meshes match by identity; other scene meshes remain renderable through the shared Forward compatibility path.

    exposure?: number

    Exposure multiplier applied before the ACES display transform. Defaults to 1.

    groundTruthAmbientOcclusion?:
        | false
        | Readonly<GroundTruthAmbientOcclusionOptions>

    Integrated ground-truth ambient occlusion. Disabled by default. The GPU Scene path reuses temporal motion data and therefore requires temporalAA when enabled.

    hiZ?: boolean

    Enable previous-frame Hi-Z occlusion. Defaults to true.

    maxLightIndices?: number

    Global cluster light-index budget. Defaults to 1,048,576 indices.

    maxLights?: number

    GPU light-database capacity. Extra traversal-order lights are deterministically dropped.

    maxLightsPerCluster?: number

    Per-cluster allocation ceiling. Defaults to 96.

    maxObjects?: number

    Stable fixed-bucket GPU Scene object capacity. Compatible excess PBR uses the direct native clustered lane; unsupported content uses Forward compatibility. Defaults to 16,384.

    maxViewportHeight?: number

    Largest supported physical output height. Defaults to 1440.

    maxViewportWidth?: number

    Largest supported physical output width. Defaults to 2560.

    screenSpaceGlobalIllumination?:
        | false
        | Readonly<ScreenSpaceGlobalIlluminationOptions>

    Temporally accumulated screen-space diffuse global illumination. Disabled by default. The GPU Scene path reuses motion and material attributes and therefore requires temporalAA.

    screenSpaceReflections?: false | Readonly<ScreenSpaceReflectionsOptions>

    Hierarchical, temporally accumulated screen-space reflections. Disabled by default. Enabling this production path requires both hiZ and temporalAA.

    temporalAA?: false | Readonly<TemporalAAOptions>

    Integrated temporal AA/TAAU. Disabled by default; false explicitly disables it.

    tileSize?: number

    Cluster tile width and height in physical pixels. Defaults to 32.

    toneMapping?: "aces" | "filmic"

    HDR display curve. Defaults to ACES; filmic preserves a softer storm-sky shoulder.

    variantManifest?: Readonly<ClusteredMaterialVariantManifest>

    Optional bounded material/deformation topology manifest translated during async creation.

    volumetricLighting?: false | Readonly<VolumetricLightingOptions>

    Camera-aligned froxel fog and volumetric local-light scattering. Disabled by default. This WebGPU path uses the complete 3D cluster light grid and submission-aware history.

    zSlices?: number

    Logarithmic view-depth slice count. Defaults to 24.

    Settings
    Member Visibility

    On This Page
    Properties