GPUDevice: createCommandEncoder() method
The createCommandEncoder()
method of the GPUDevice
interface creates a GPUCommandEncoder
, used to encode commands to be issued to the GPU.
Syntax
createCommandEncoder()
createCommandEncoder(descriptor)
Parameters
descriptor
Optional
-
An object containing the following properties:
label
Optional
-
A string providing a label that can be used to identify the object, for example in GPUError
messages or console warnings.
Return value
A GPUCommandEncoder
object instance.
Examples
In our basic render demo, several commands are recorded via a GPUCommandEncoder
created via createCommandEncoder()
:
const commandEncoder = device.createCommandEncoder();
const renderPassDescriptor = {
colorAttachments: [
{
clearValue: clearColor,
loadOp: "clear",
storeOp: "store",
view: context.getCurrentTexture().createView(),
},
],
};
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.draw(3);
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 command encoding examples.
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
createCommandEncoder |
113Currently supported on ChromeOS, macOS, and Windows only.
|
113Currently supported on ChromeOS, macOS, and Windows only.
|
previewCurrently supported on Linux and Windows only.
|
No |
99Currently supported on ChromeOS, macOS, and Windows only.
|
No |
No |
No |
No |
No |
No |
No |
See also