Luxar Viewer API Documentation - v2026.10.22
    Preparing search index...

    Interface CreateWebGPUOptions

    Options that createWebGPURenderer honours.

    interface CreateWebGPUOptions {
        debug?: boolean;
        webgpuForceWebGL?: boolean;
        perfTimestamp?: boolean;
        rendererOverride?: "webgl" | "webgpu";
        requireNativeAdapter?: boolean;
        platformRules?: readonly WebGPUPlatformRule[];
        hdr?: boolean;
        hdrHeadroom?: number;
        preRequestedWebGPUDevice?: Promise<WebGPUDeviceRequest>;
    }
    Index
    debug? webgpuForceWebGL? perfTimestamp? rendererOverride? requireNativeAdapter? platformRules? hdr? hdrHeadroom? preRequestedWebGPUDevice?
    debug?: boolean

    When true, log hardware point-size limits for diagnostics.

    webgpuForceWebGL?: boolean

    Diagnostic mode: keep WebGPURenderer + TSL NodeMaterial dispatch but make Three use its internal WebGL2 backend. Mutually exclusive with a pre-built device.

    perfTimestamp?: boolean

    Opt into GPU timestamp queries. Three.js gates the pool's allocation on device.features.has('timestamp-query'), so setting this is safe on drivers without the feature.

    rendererOverride?: "webgl" | "webgpu"

    Honour an explicit ?renderer=webgpu override even when the adapter advertises maxVertexBuffers < 8. Used by the WebGPU auto-fallback logic to decide whether to drop to WebGL or push through on a degenerate adapter.

    requireNativeAdapter?: boolean

    Return { fallback: true } when no native WebGPU device can be obtained (no navigator.gpu, no adapter, or requestDevice failed) instead of constructing a WebGPURenderer that three would run on its WebGL2 backend. Ignored with webgpuForceWebGL, which asks for that backend.

    platformRules?: readonly WebGPUPlatformRule[]

    The platform-policy rules the adapter must satisfy (BackendSelection.platformRules); an adapter matching none returns { fallback: true }.

    hdr?: boolean

    PROTOTYPE: request extended-range (HDR) output (?hdr); gated by planHdrOutput.

    hdrHeadroom?: number

    Pinned HDR headroom (?hdr=<n>); omitted = resolved per display.

    preRequestedWebGPUDevice?: Promise<WebGPUDeviceRequest>

    One-shot device request started by standalone bootstrap. Never use for recovery.

    Settings
    Member Visibility

    On This Page
    Properties