GPUQueue: submit() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
The submit()
method of the
GPUQueue
interface schedules the execution of command buffers represented by one or more GPUCommandBuffer
objects by the GPU.
Syntax
submit(commandBuffers)
Parameters
commandBuffers
-
An array of
GPUCommandBuffer
objects containing the commands to be enqueued for processing by the GPU.
Return value
None (Undefined
).
Validation
The following criteria must be met when calling submit()
, otherwise a GPUValidationError
is generated and the GPUQueue
becomes invalid:
- Any
GPUBuffer
,GPUTexture
, andGPUQuerySet
objects used in the encoded commands are available for use, i.e. not unavailable (GPUBuffer
s are unavailable if they are currently mapped) or destroyed (with thedestroy()
method). - Any
GPUExternalTexture
objects used in the encoded commands are not expired (they expire automatically shortly after being imported viaimportExternalTexture()
). - If a
GPUQuerySet
object used in an encoded command is of type"occlusion"
query, it is not already used, except byGPURenderPassEncoder.beginOcclusionQuery()
.
Examples
In our basic render demo, a number of commands are recorded via a GPUCommandEncoder
:
// ...
// Create GPUCommandEncoder
const commandEncoder = device.createCommandEncoder();
// Create GPURenderPassDescriptor to tell WebGPU which texture to draw into, then initiate render pass
const renderPassDescriptor = {
colorAttachments: [
{
clearValue: clearColor,
loadOp: "clear",
storeOp: "store",
view: context.getCurrentTexture().createView(),
},
],
};
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
// Draw a triangle
passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.draw(3);
// End the render pass
passEncoder.end();
// ...
The commands encoded by the GPUCommandEncoder
are recoded into a GPUCommandBuffer
using the GPUCommandEncoder.finish()
method. The command buffer is then passed into the queue via a submit()
call, ready to be processed by the GPU.
device.queue.submit([commandEncoder.finish()]);
Note: Study the WebGPU samples to find more queue examples.
Specifications
Specification |
---|
WebGPU # dom-gpuqueue-submit |
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API