Class GPUQueue

Namespace

CSharpToJavaScript.APIs.JS

Assembly

CSharpToJavaScript.dll

The GPUQueue interface of the {{domxref("WebGPU API", "WebGPU API", "", "nocode")}} controls execution of encoded commands on the GPU.

[Value("GPUQueue")]
public class GPUQueue

Inheritance

object

GPUQueue

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

A device's primary queue is accessed via the Queue property.

-The WebGPU API

See also on MDN

Constructors

GPUQueue()

public GPUQueue()

Methods

CopyExternalImageToTexture(GPUCopyExternalImageSourceInfo, GPUCopyExternalImageDestInfo, Union222)

The copyExternalImageToTexture() method of the
GPUQueue interface copies a snapshot taken from a source image, video, or canvas into a given GPUTexture.

[Value("copyExternalImageToTexture")]
public GlobalObject.Undefined CopyExternalImageToTexture(GPUCopyExternalImageSourceInfo source, GPUCopyExternalImageDestInfo destination, Union222 copySize)

Parameters

source GPUCopyExternalImageSourceInfo

destination GPUCopyExternalImageDestInfo

copySize Union222

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

Using this function allows the user agent to determine the most efficient way to copy the data over for each source type.

-The WebGPU API

See also on MDN

OnSubmittedWorkDone()

The onSubmittedWorkDone() method of the
GPUQueue interface returns a {{jsxref("Promise")}} that resolves when all the work submitted to the GPU via this GPUQueue at the point the method is called has been processed.

[Value("onSubmittedWorkDone")]
public Task<GlobalObject.Undefined> OnSubmittedWorkDone()

Returns

Task<GlobalObject.Undefined>

A Promise that resolves with GlobalObject.Undefined.

Remarks

This includes the completion of any MapAsync(ulong, ulong, ulong) calls made on GPUBuffers used in commands submitted to the queue, before onSubmittedWorkDone() is called.

Note: In most cases, you do not need to call onSubmittedWorkDone(). You do not need to call it for mapping a buffer. mapAsync guarantees work submitted to the queue before calling mapAsync happens before the mapAsync returns (see WebGPU spec).

The two use cases for onSubmittedWorkDone

-The WebGPU API

See also on MDN

Submit(List<GPUCommandBuffer>)

The submit() method of the
GPUQueue interface schedules the execution of command buffers represented by one or more GPUCommandBuffer objects by the GPU.

[Value("submit")]
public GlobalObject.Undefined Submit(List<GPUCommandBuffer> commandBuffers)

Parameters

commandBuffers List<GPUCommandBuffer>

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

-The WebGPU API

See also on MDN

WriteBuffer(GPUBuffer, ulong, Union225, ulong, ulong)

The writeBuffer() method of the
GPUQueue interface writes a provided data source into a given GPUBuffer.

[Value("writeBuffer")]
public GlobalObject.Undefined WriteBuffer(GPUBuffer buffer, ulong bufferOffset, Union225 data, ulong dataOffset = 0, ulong size = 0)

Parameters

buffer GPUBuffer

bufferOffset ulong

data Union225

dataOffset ulong

size ulong

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

This is a convenience function, which provides an alternative to setting buffer data via buffer mapping and buffer-to-buffer copies. It lets the user agent determine the most efficient way to copy the data over.

-The WebGPU API

See also on MDN

WriteTexture(GPUTexelCopyTextureInfo, Union225, GPUTexelCopyBufferLayout, Union222)

The writeTexture() method of the
GPUQueue interface writes a provided data source into a given GPUTexture.

[Value("writeTexture")]
public GlobalObject.Undefined WriteTexture(GPUTexelCopyTextureInfo destination, Union225 data, GPUTexelCopyBufferLayout dataLayout, Union222 size)

Parameters

destination GPUTexelCopyTextureInfo

data Union225

dataLayout GPUTexelCopyBufferLayout

size Union222

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

This is a convenience function, which provides an alternative to setting texture data via buffer mapping and buffer-to-texture copies. It lets the user agent determine the most efficient way to copy the data over.

-The WebGPU API

See also on MDN