Interface WebGPURendererParams

Configuration for WebGPURenderer.

interface WebGPURendererParams {
    adapter?: WebGPUAdapterLike;
    alphaMode?: WebGPUCanvasAlphaMode;
    contextFormat?: string;
    destroyDeviceOnDestroy?: boolean;
    device?: WebGPUDeviceLike;
    deviceDescriptor?: object;
    logging?: boolean;
    requestAdapterOptions?: object;
    viewer?: Viewer;
}

Properties

adapter? alphaMode? contextFormat? destroyDeviceOnDestroy? device? deviceDescriptor? logging? requestAdapterOptions? viewer?

Properties

Optionaladapter

adapter?: WebGPUAdapterLike

Adapter used by WebGPURenderer.create. Ignored by the synchronous constructor because GPUAdapter.requestDevice is asynchronous.

OptionalalphaMode

alphaMode?: WebGPUCanvasAlphaMode

Optional alpha mode override for configured view canvases.

By default transparent views use premultiplied; opaque views use opaque.

OptionalcontextFormat

contextFormat?: string

Canvas texture format. Defaults to navigator.gpu.getPreferredCanvasFormat() when available, otherwise bgra8unorm.

OptionaldestroyDeviceOnDestroy

destroyDeviceOnDestroy?: boolean

Whether WebGPURenderer.destroy should call device.destroy().

Defaults to false for injected devices and true for devices acquired by WebGPURenderer.create.

Optionaldevice

device?: WebGPUDeviceLike

Pre-created WebGPU device.

Supplying this allows the synchronous WebGPURenderer.attachViewer method to satisfy the backend-neutral Renderer contract.

OptionaldeviceDescriptor

deviceDescriptor?: object

Descriptor used by WebGPURenderer.create when requesting a device.

Optionallogging

logging?: boolean

Enables renderer error logging.

Default value is true.

OptionalrequestAdapterOptions

requestAdapterOptions?: object

Options used by WebGPURenderer.create when requesting an adapter.

Optionalviewer

viewer?: Viewer

Viewer to attach during construction.

When no device is supplied, attachment still returns base!core.SDKErrorType.NotSupported; use WebGPURenderer.create to request a device first.

Settings

Member Visibility

On This Page

Properties