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

    Interface ReflectionProbePipelineOptions

    Bounded dynamic reflection capture around an existing shared rendering pipeline.

    interface ReflectionProbePipelineOptions {
        facesPerFrame?: number;
        far?: number;
        filterLevelsPerFrame?: number;
        filterSamples?: 32 | 64 | 128;
        maxResidentBytes?: number;
        near?: number;
        pipeline?: RenderPipelineFactory;
        probes: readonly ReflectionProbe[];
        resolution?: number;
        roughnessLevels?: number;
        visibility?: number;
    }
    Index
    facesPerFrame? far? filterLevelsPerFrame? filterSamples? maxResidentBytes? near? pipeline? probes resolution? roughnessLevels? visibility?
    facesPerFrame?: number

    Maximum scene faces recorded in one application frame, in [1, 6]. Defaults to one.

    far?: number

    Capture far plane. Defaults to 100 world units.

    filterLevelsPerFrame?: number

    Maximum roughness bands recorded in one application frame, in [1, 8]. Defaults to one.

    filterSamples?: 32 | 64 | 128

    GGX importance samples per filtered pixel: 32, 64 or 128. Defaults to 64.

    maxResidentBytes?: number

    Hard byte budget for capture color/depth and double-buffered filtered radiance. Defaults to 64 MiB.

    near?: number

    Capture near plane. Defaults to 0.05 world units.

    pipeline?: RenderPipelineFactory

    Main view pipeline. Defaults to portable Forward.

    probes: readonly ReflectionProbe[]

    Distinct dynamic probes. At most eight are resident; materials bind a spatially relevant pair.

    resolution?: number

    Cube face size, a power of two in [16, 256]. Defaults to 128.

    roughnessLevels?: number

    Roughness bands in [2, 8], bounded by log2(resolution) + 1. Defaults to five.

    visibility?: number

    Camera layer mask. Defaults to all layers. Local-probe receivers are excluded to avoid recursion.

    Settings
    Member Visibility

    On This Page
    Properties