GPUDevice
The GPUDevice interface of the WebGPU API represents a logical GPU device. This is the main interface through which the majority of WebGPU functionality is accessed.
Available only in secure contexts.
Extends
Methods
addEventListener()
Call Signature
addEventListener<K>(
type,
listener,
options?
): void;
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Type Parameters
| Type Parameter |
|---|
K extends "uncapturederror" |
Parameters
| Parameter | Type |
|---|---|
type | K |
listener | (this, ev) => any |
options? | boolean | AddEventListenerOptions |
Returns
void
Overrides
Call Signature
addEventListener(
type,
listener,
options?
): void;
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | AddEventListenerOptions |
Returns
void
Overrides
EventTarget.addEventListener
createBindGroup()
createBindGroup(descriptor): GPUBindGroup;
The createBindGroup() method of the GPUDevice interface creates a GPUBindGroup based on a GPUBindGroupLayout that defines a set of resources to be bound together in a group and how those resources are used in shader stages.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUBindGroupDescriptor |
Returns
createBindGroupLayout()
createBindGroupLayout(descriptor): GPUBindGroupLayout;
The createBindGroupLayout() method of the GPUDevice interface creates a GPUBindGroupLayout that defines the structure and purpose of related GPU resources such as buffers that will be used in a pipeline, and is used as a template when creating GPUBindGroups.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUBindGroupLayoutDescriptor |
Returns
createBuffer()
createBuffer(descriptor): GPUBuffer;
The createBuffer() method of the GPUDevice interface creates a GPUBuffer in which to store raw data to use in GPU operations.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUBufferDescriptor |
Returns
createCommandEncoder()
createCommandEncoder(descriptor?): GPUCommandEncoder;
The createCommandEncoder() method of the GPUDevice interface creates a GPUCommandEncoder, used to encode commands to be issued to the GPU.
Parameters
| Parameter | Type |
|---|---|
descriptor? | GPUCommandEncoderDescriptor |
Returns
createComputePipeline()
createComputePipeline(descriptor): GPUComputePipeline;
The createComputePipeline() method of the GPUDevice interface creates a GPUComputePipeline that can control the compute shader stage and be used in a GPUComputePassEncoder.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUComputePipelineDescriptor |
Returns
createComputePipelineAsync()
createComputePipelineAsync(descriptor): Promise<GPUComputePipeline>;
The createComputePipelineAsync() method of the GPUDevice interface returns a Promise that fulfills with a GPUComputePipeline, which can control the compute shader stage and be used in a GPUComputePassEncoder, once the pipeline can be used without any stalling.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUComputePipelineDescriptor |
Returns
Promise<GPUComputePipeline>
createPipelineLayout()
createPipelineLayout(descriptor): GPUPipelineLayout;
The createPipelineLayout() method of the GPUDevice interface creates a GPUPipelineLayout that defines the GPUBindGroupLayouts used by a pipeline. GPUBindGroups used with the pipeline during command encoding must have compatible GPUBindGroupLayouts.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUPipelineLayoutDescriptor |
Returns
createQuerySet()
createQuerySet(descriptor): GPUQuerySet;
The createQuerySet() method of the GPUDevice interface creates a GPUQuerySet that can be used to record the results of queries on passes, such as occlusion or timestamp queries.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUQuerySetDescriptor |
Returns
createRenderBundleEncoder()
createRenderBundleEncoder(descriptor): GPURenderBundleEncoder;
The createRenderBundleEncoder() method of the GPUDevice interface creates a GPURenderBundleEncoder that can be used to pre-record bundles of commands. These can be reused in GPURenderPassEncoders via the executeBundles() method, as many times as required.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPURenderBundleEncoderDescriptor |
Returns
createRenderPipeline()
createRenderPipeline(descriptor): GPURenderPipeline;
The createRenderPipeline() method of the GPUDevice interface creates a GPURenderPipeline that can control the vertex and fragment shader stages and be used in a GPURenderPassEncoder or GPURenderBundleEncoder.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPURenderPipelineDescriptor |
Returns
createRenderPipelineAsync()
createRenderPipelineAsync(descriptor): Promise<GPURenderPipeline>;
The createRenderPipelineAsync() method of the GPUDevice interface returns a Promise that fulfills with a GPURenderPipeline, which can control the vertex and fragment shader stages and be used in a GPURenderPassEncoder or GPURenderBundleEncoder, once the pipeline can be used without any stalling.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPURenderPipelineDescriptor |
Returns
Promise<GPURenderPipeline>
createSampler()
createSampler(descriptor?): GPUSampler;
The createSampler() method of the GPUDevice interface creates a GPUSampler, which controls how shaders transform and filter texture resource data.
Parameters
| Parameter | Type |
|---|---|
descriptor? | GPUSamplerDescriptor |
Returns
createShaderModule()
createShaderModule(descriptor): GPUShaderModule;
The createShaderModule() method of the GPUDevice interface creates a GPUShaderModule from a string of WGSL source code.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUShaderModuleDescriptor |
Returns
createTexture()
createTexture(descriptor): GPUTexture;
The createTexture() method of the GPUDevice interface creates a GPUTexture in which to store 1D, 2D, or 3D arrays of data, such as images, to use in GPU rendering operations.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUTextureDescriptor |
Returns
destroy()
destroy(): void;
The destroy() method of the GPUDevice interface destroys the device, preventing further operations on it.
Returns
void
dispatchEvent()
dispatchEvent(event): boolean;
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
Parameters
| Parameter | Type |
|---|---|
event | Event |
Returns
boolean
Inherited from
importExternalTexture()
importExternalTexture(descriptor): GPUExternalTexture;
The importExternalTexture() method of the GPUDevice interface takes an HTMLVideoElement or a VideoFrame object as an input and returns a GPUExternalTexture wrapper object containing a snapshot of the video that can be used as a frame in GPU rendering operations.
Parameters
| Parameter | Type |
|---|---|
descriptor | GPUExternalTextureDescriptor |
Returns
popErrorScope()
popErrorScope(): Promise<GPUError | null>;
The popErrorScope() method of the GPUDevice interface pops an existing GPU error scope from the error scope stack (originally pushed using GPUDevice.pushErrorScope()) and returns a Promise that resolves to an object describing the first error captured in the scope, or null if no error occurred.
Returns
Promise<GPUError | null>
pushErrorScope()
pushErrorScope(filter): void;
The pushErrorScope() method of the GPUDevice interface pushes a new GPU error scope onto the device's error scope stack, allowing you to capture errors of a particular type.
Parameters
| Parameter | Type |
|---|---|
filter | GPUErrorFilter |
Returns
void
removeEventListener()
Call Signature
removeEventListener<K>(
type,
listener,
options?
): void;
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Type Parameters
| Type Parameter |
|---|
K extends "uncapturederror" |
Parameters
| Parameter | Type |
|---|---|
type | K |
listener | (this, ev) => any |
options? | boolean | EventListenerOptions |
Returns
void
Overrides
EventTarget.removeEventListener
Call Signature
removeEventListener(
type,
listener,
options?
): void;
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | EventListenerOptions |
Returns
void
Overrides
EventTarget.removeEventListener
Properties
adapterInfo
readonly adapterInfo: GPUAdapterInfo;
The adapterInfo read-only property of the GPUDevice interface returns a GPUAdapterInfo object containing identifying information about the device's originating adapter.
features
readonly features: GPUSupportedFeatures;
The features read-only property of the GPUDevice interface returns a GPUSupportedFeatures object that describes additional functionality supported by the device. Only features requested during the creation of the device (i.e., when GPUAdapter.requestDevice() is called) are included.
label
label: string;
Inherited from
limits
readonly limits: GPUSupportedLimits;
The limits read-only property of the GPUDevice interface returns a GPUSupportedLimits object that describes the limits supported by the device. All limit values will be included, and the limits requested during the creation of the device (i.e., when GPUAdapter.requestDevice() is called) will be reflected in those values.
lost
readonly lost: Promise<GPUDeviceLostInfo>;
The lost read-only property of the GPUDevice interface contains a Promise that remains pending throughout the device's lifetime and resolves with a GPUDeviceLostInfo object when the device is lost.
onuncapturederror
onuncapturederror: ((this, ev) => any) | null;
queue
readonly queue: GPUQueue;
The queue read-only property of the GPUDevice interface returns the primary GPUQueue for the device.