GPUComputePassEncoder

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.

Note: This feature is available inWeb Workers.

TheGPUComputePassEncoder interface of theWebGPU API encodes commands related to controlling the compute shader stage, as issued by aGPUComputePipeline. It forms part of the overall encoding activity of aGPUCommandEncoder.

A compute pipeline contains a single compute stage in which a compute shader takes general data, processes it in parallel across a specified number of workgroups, then returns the result in one or more buffers.

AGPUComputePassEncoder object instance is created via theGPUCommandEncoder.beginComputePass() property.

Instance properties

label: A string providing a label that can be used to identify the object, for example inGPUError messages or console warnings.

Instance methods

dispatchWorkgroups(): Dispatches a specific grid of workgroups to perform the work being done by the currentGPUComputePipeline.
dispatchWorkgroupsIndirect(): Dispatches a grid of workgroups, defined by the parameters of aGPUBuffer, to perform the work being done by the currentGPUComputePipeline.
end(): Completes recording of the current compute pass command sequence.
insertDebugMarker(): Marks a specific point in a series of encoded commands with a label.
popDebugGroup(): Ends a debug group, which is begun with apushDebugGroup() call.
pushDebugGroup(): Begins a debug group, which is marked with a specified label, and will contain all subsequent encoded commands up until apopDebugGroup() method is invoked.
setBindGroup(): Sets theGPUBindGroup to use for subsequent compute commands, for a given index.
setPipeline(): Sets theGPUComputePipeline to use for this compute pass.

Examples

In ourbasic compute demo, several commands are recorded via aGPUCommandEncoder. Most of these commands originate from theGPUComputePassEncoder created viaGPUCommandEncoder.beginComputePass().

// …// Create GPUCommandEncoder to encode commands to issue to the GPUconst commandEncoder = device.createCommandEncoder();// Create GPUComputePassEncoder to initiate compute passconst passEncoder = commandEncoder.beginComputePass();// Issue commandspassEncoder.setPipeline(computePipeline);passEncoder.setBindGroup(0, bindGroup);passEncoder.dispatchWorkgroups(Math.ceil(BUFFER_SIZE / 64));// End the compute passpassEncoder.end();// Copy output buffer to staging buffercommandEncoder.copyBufferToBuffer(  output,  0, // Source offset  stagingBuffer,  0, // Destination offset  BUFFER_SIZE,);// End frame by passing array of command buffers to command queue for executiondevice.queue.submit([commandEncoder.finish()]);// …