Interface WebGPUDeviceLike

Minimal WebGPU device shape used by WebGPURenderer.

Use this when injecting a custom device into WebGPURenderer or WebGPURenderer.create without requiring ambient WebGPU DOM typings.

interface WebGPUDeviceLike {
    features?: { has(feature: string): boolean };
    lost?: Promise<WebGPUDeviceLostInfoLike>;
    queue: WebGPUQueueLike;
    createBindGroup(descriptor: object): object;
    createBindGroupLayout(descriptor: object): object;
    createBuffer(descriptor: object): WebGPUBufferLike;
    createCommandEncoder(): WebGPUCommandEncoderLike;
    createPipelineLayout(descriptor: object): object;
    createQuerySet(descriptor: object): WebGPUQuerySetLike;
    createRenderPipeline(descriptor: object): object;
    createSampler(descriptor: object): object;
    createShaderModule(descriptor: object): object;
    createTexture(descriptor: object): WebGPUTextureLike;
    destroy(): void;
}

Index

Properties

features? lost? queue

Methods

createBindGroup createBindGroupLayout createBuffer createCommandEncoder createPipelineLayout createQuerySet? createRenderPipeline createSampler? createShaderModule createTexture destroy?

Properties

`Optional` `Readonly`features

features?: { has(feature: string): boolean }

Device feature set queried before using optional renderer features.

Type declaration

has:function
- has(feature: string): boolean
  Returns whether the device exposes the named WebGPU feature.
  Parameters
  - feature: string
  Returns boolean
  - Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:44

`Optional` `Readonly`lost

lost?: Promise<WebGPUDeviceLostInfoLike>

Optional WebGPU device-lost promise.

`Readonly`queue

queue: WebGPUQueueLike

Queue used by the renderer for buffer writes, texture writes, and command submission.

Methods

createBindGroup

createBindGroup(descriptor: object): object
Creates a bind group.
Parameters
- descriptor: object
Returns object
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:85

createBindGroupLayout

createBindGroupLayout(descriptor: object): object
Creates a bind group layout.
Parameters
- descriptor: object
Returns object
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:70

createBuffer

createBuffer(descriptor: object): WebGPUBufferLike
Creates a GPU buffer.
Parameters
- descriptor: object
Returns WebGPUBufferLike
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:50

createCommandEncoder

createCommandEncoder(): WebGPUCommandEncoderLike
Creates a command encoder for one or more render passes.

Returns WebGPUCommandEncoderLike
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:95

createPipelineLayout

createPipelineLayout(descriptor: object): object
Creates a pipeline layout.
Parameters
- descriptor: object
Returns object
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:75

`Optional`createQuerySet

createQuerySet(descriptor: object): WebGPUQuerySetLike
Creates a GPU query set, when supported by the device.
Parameters
- descriptor: object
Returns WebGPUQuerySetLike
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:60

createRenderPipeline

createRenderPipeline(descriptor: object): object
Creates a render pipeline.
Parameters
- descriptor: object
Returns object
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:80

`Optional`createSampler

createSampler(descriptor: object): object
Creates a sampler, when supported by the device.
Parameters
- descriptor: object
Returns object
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:90

createShaderModule

createShaderModule(descriptor: object): object
Creates a shader module.
Parameters
- descriptor: object
Returns object
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:65

createTexture

createTexture(descriptor: object): WebGPUTextureLike
Creates a GPU texture.
Parameters
- descriptor: object
Returns WebGPUTextureLike
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:55

`Optional`destroy

destroy(): void
Releases the device when the injected or acquired device owner allows destruction.

Returns void
- Defined in packages/sdk/src/viewing/webGPURenderer/core/types/WebGPUDeviceLike.ts:100

Interface WebGPUDeviceLike

Index

Properties

Methods

Properties

Optional Readonlyfeatures

Type declaration

has:function

Parameters

Returns boolean

Optional Readonlylost

Readonlyqueue

Methods

createBindGroup

Parameters

Returns object

createBindGroupLayout

Parameters

Returns object

createBuffer

Parameters

Returns WebGPUBufferLike

createCommandEncoder

Returns WebGPUCommandEncoderLike

createPipelineLayout

Parameters

Returns object

OptionalcreateQuerySet

Parameters

Returns WebGPUQuerySetLike

createRenderPipeline

Parameters

Returns object

OptionalcreateSampler

Parameters

Returns object

createShaderModule

Parameters

Returns object

createTexture

Parameters

Returns WebGPUTextureLike

Optionaldestroy

Returns void

Settings

On This Page

`Optional` `Readonly`features

`Optional` `Readonly`lost

`Readonly`queue

`Optional`createQuerySet

`Optional`createSampler

`Optional`destroy