WebGPU API
The setBindGroup() method of the
GPURenderBundleEncoder interface sets the GPUBindGroup to use for subsequent render bundle commands, for a given index.
[!NOTE] This method is functionally identical to its equivalent on GPURenderPassEncoder — GPURenderPassEncoder.setBindGroup.
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 render bundle commands, or
null, in which case any previously-set bind group in the given slot is unset.
- : The GPUBindGroup to use for subsequent render bundle 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 setBindGroup(), otherwise a GPUValidationError is generated and the GPURenderBundleEncoder 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
function recordRenderPass(passEncoder) {
if (settings.dynamicOffsets) {
passEncoder.setPipeline(dynamicPipeline);
} else {
passEncoder.setPipeline(pipeline);
}
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setBindGroup(0, timeBindGroup);
const dynamicOffsets = [0];
for (let i = 0; i < numTriangles; ++i) {
if (settings.dynamicOffsets) {
dynamicOffsets[0] = i * alignedUniformBytes;
passEncoder.setBindGroup(1, dynamicBindGroup, dynamicOffsets);
} else {
passEncoder.setBindGroup(1, bindGroups[i]);
}
passEncoder.draw(3, 1, 0, 0);
}
}
The above snippet is taken from the WebGPU Samples Animometer example.
Unset bind group
// Set bind group in slot 0
passEncoder.setBindGroup(0, timeBindGroup);
// 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。离线整理了版式、链接和媒体显示。
