WebGPU API
The GPUCommandEncoder interface of the WebGPU API represents an encoder that collects a sequence of GPU commands to be issued to the GPU.
A GPUCommandEncoder object instance is created via the GPUDevice.createCommandEncoder() property.
Instance properties
- GPUCommandEncoder.label
- : A string providing a label that can be used to identify the object, for example in GPUError messages or console warnings.
Instance methods
-
GPUCommandEncoder.beginComputePass
- : Starts encoding a compute pass, returning a GPUComputePassEncoder that can be used to control computation.
-
GPUCommandEncoder.beginRenderPass
- : Starts encoding a render pass, returning a GPURenderPassEncoder that can be used to control rendering.
-
GPUCommandEncoder.clearBuffer
- : Encodes a command that fills a region of a GPUBuffer with zeroes.
-
GPUCommandEncoder.copyBufferToBuffer
- : Encodes a command that copies data from one GPUBuffer to another.
-
GPUCommandEncoder.copyBufferToTexture
- : Encodes a command that copies data from a GPUBuffer to a GPUTexture.
-
GPUCommandEncoder.copyTextureToBuffer
- : Encodes a command that copies data from a GPUTexture to a GPUBuffer.
-
GPUCommandEncoder.copyTextureToTexture
- : Encodes a command that copies data from one GPUTexture to another.
-
GPUCommandEncoder.finish
- : Completes recording of the command sequence encoded on this
GPUCommandEncoder, returning a corresponding GPUCommandBuffer.
- : Completes recording of the command sequence encoded on this
-
GPUCommandEncoder.insertDebugMarker
- : Marks a specific point in a series of encoded commands with a label.
-
GPUCommandEncoder.popDebugGroup
- : Ends a debug group, which is begun with a GPUCommandEncoder.pushDebugGroup call.
-
GPUCommandEncoder.pushDebugGroup
- : Begins a debug group, which is marked with a specified label, and will contain all subsequent encoded commands up until a GPUCommandEncoder.popDebugGroup method is invoked.
-
GPUCommandEncoder.resolveQuerySet
- : Encodes a command that resolves a GPUQuerySet, copying the results into a specified GPUBuffer.
-
GPUCommandEncoder.writeTimestamp
- : Encodes a command that writes a timestamp into a GPUQuerySet once the previous commands recorded into the same queued GPUCommandBuffer have been executed by the GPU.
Examples
In our basic render demo, several 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 recorded into a GPUCommandBuffer using the GPUCommandEncoder.finish() method. The command buffer is then passed into the queue via a GPUQueue.submit call, ready to be processed by the GPU.
device.queue.submit([commandEncoder.finish()]);
[!NOTE] Study the WebGPU samples to find more command encoding examples.
Specifications
Browser compatibility
See also
- The WebGPU API
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
