WebGPU API
The setBindGroup() method of the
GPUComputePassEncoder interface sets the GPUBindGroup to use for subsequent compute commands, for a given index.
Syntax
setBindGroup(index, bindGroup)
setBindGroup(index, bindGroup, dynamicOffsets)
setBindGroup(index, bindGroup, dynamicOffsets, dynamicOffsetsStart,
dynamicOffsetsLength)
Parameters
index- : The index to set the bind group at. This matches the
nindex value of the corresponding@group(n)attribute in the shader code (GPUShaderModule) used in the related pipeline.
- : The index to set the bind group at. This matches the
bindGroup- : The GPUBindGroup to use for subsequent compute commands, or
null, in which case any previously-set bind group in the given slot is unset.
- : The GPUBindGroup to use for subsequent compute commands, or
dynamicOffsets- : A value specifying the offset, in bytes, for each entry in
bindGroupwithhasDynamicOffset: trueset (i.e., in the descriptor of the GPUDevice.createBindGroupLayout() call that created the GPUBindGroupLayout object that thebindGroupis based on). This value can be:- An array of numbers specifying the different offsets.
- A Uint32Array containing numbers specifying the offsets.
- : A value specifying the offset, in bytes, for each entry in
If a Uint32Array value is specified for dynamicOffsets, both of the following parameters are also required:
dynamicOffsetsStart- : A number specifying the offset, in array elements, into
dynamicOffsetsData, where the dynamic offset data begins.
- : A number specifying the offset, in array elements, into
dynamicOffsetsLength- : A number specifying the number of dynamic offset values to be read from in
dynamicOffsetsData.
- : A number specifying the number of dynamic offset values to be read from in
Return value
None (undefined).
Exceptions
For setBindGroup() calls that use a Uint32Array value for dynamicOffsets, the call will throw with a RangeError if:
dynamicOffsetsStartis less than 0.dynamicOffsetsStart+dynamicOffsetsLengthis greater thandynamicOffsets.length.
Validation
The following criteria must be met when calling dispatchWorkgroups(), otherwise a GPUValidationError is generated and the GPUComputePassEncoder becomes invalid:
indexis less than or equal to the GPUDevice'smaxBindGroupsGPUSupportedLimits.dynamicOffsets.lengthis the same as the number of entries inbindGroupwithhasDynamicOffset: trueset.- For
bindGroupentries where the boundbuffer'stypeis"uniform"(see GPUDevice.createBindGroupLayout()), each number indynamicOffsetsis a multiple of the GPUDevice'sminUniformBufferOffsetAlignmentGPUSupportedLimits. - For
bindGroupentries where the boundbuffer'stypeis"storage"or"read-only-storage"(see GPUDevice.createBindGroupLayout()), each number indynamicOffsetsis a multiple of the GPUDevice'sminStorageBufferOffsetAlignmentGPUSupportedLimits. - For each
bindGroupentry, the boundbuffer'soffset, plus the corresponding layout entry'sminBindingSize, plus the corresponding dynamic offset specified indynamicOffsets, is less than or equal to the boundbuffer'ssize.
Examples
Set bind group
In our basic compute demo, several commands are recorded via a GPUCommandEncoder. Most of these commands originate from the GPUComputePassEncoder created via beginComputePass(). The setBindGroup() call used here is the simplest form, just specifying index and bind group.
const BUFFER_SIZE = 1000;
// …
// Create GPUCommandEncoder to encode commands to issue to the GPU
const commandEncoder = device.createCommandEncoder();
// Initiate compute pass
const passEncoder = commandEncoder.beginComputePass();
// Issue commands
passEncoder.setPipeline(computePipeline);
passEncoder.setBindGroup(0, bindGroup);
passEncoder.dispatchWorkgroups(Math.ceil(BUFFER_SIZE / 64));
// End the render pass
passEncoder.end();
// Copy output buffer to staging buffer
commandEncoder.copyBufferToBuffer(
output,
0, // Source offset
stagingBuffer,
0, // Destination offset
BUFFER_SIZE,
);
// End frame by passing array of command buffers to command queue for execution
device.queue.submit([commandEncoder.finish()]);
// …
Unset bind group
// Set bind group in slot 0
passEncoder.setBindGroup(0, bindGroup);
// Later, unset bind group in slot 0
passEncoder.setBindGroup(0, null);
Specifications
Browser compatibility
See also
- The WebGPU API
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
