GPUComputePassEncoder: setBindGroup()-Methode

Syntax

setBindGroup(index, bindGroup)
setBindGroup(index, bindGroup, dynamicOffsets)
setBindGroup(index, bindGroup, dynamicOffsets, dynamicOffsetsStart,
             dynamicOffsetsLength)

Parameter

index

Der Index, an dem die Bind-Gruppe gesetzt wird. Dies entspricht dem n-Indexwert des entsprechenden @group(n)-Attributs im Shader-Code (GPUShaderModule), der in der zugehörigen Pipeline verwendet wird.

bindGroup

Die GPUBindGroup, die für nachfolgende Compute-Befehle verwendet wird, oder null, in diesem Fall wird jede zuvor gesetzte Bind-Gruppe im angegebenen Slot aufgehoben.

dynamicOffsets Optional

Ein Wert, der den Versatz in Bytes für jeden Eintrag in bindGroup mit hasDynamicOffset: true angibt (d.h. in der Beschreibung des Aufrufs von GPUDevice.createBindGroupLayout(), der das GPUBindGroupLayout-Objekt erstellt hat, auf dem bindGroup basiert). Dieser Wert kann sein:

• Ein Array von Zahlen, das die verschiedenen Versätze angibt.
• Ein Uint32Array, das Zahlen enthält, die die Versätze angeben.

Wenn ein Uint32Array-Wert für dynamicOffsets angegeben wird, sind beide der folgenden Parameter ebenfalls erforderlich:

dynamicOffsetsStart

Eine Zahl, die den Versatz in Array-Elementen in dynamicOffsetsData angibt, wo die dynamischen Versatzdaten beginnen.

dynamicOffsetsLength

Eine Zahl, die die Anzahl der dynamischen Versatzwerte angibt, die in dynamicOffsetsData gelesen werden sollen.

Rückgabewert

Keiner (Undefined).

Ausnahmen

Bei setBindGroup()-Aufrufen, die einen Uint32Array-Wert für dynamicOffsets verwenden, wird der Aufruf mit einem RangeErrorDOMException ausgelöst, wenn:

• dynamicOffsetsStart kleiner als 0 ist.
• dynamicOffsetsStart + dynamicOffsetsLength größer als dynamicOffsets.length ist.

Validierung

Die folgenden Kriterien müssen erfüllt sein, wenn dispatchWorkgroups() aufgerufen wird, andernfalls wird ein GPUValidationError erzeugt und der GPUComputePassEncoder wird ungültig:

• index ist kleiner oder gleich der maxBindGroups-Grenze des GPUDevice.
• dynamicOffsets.length entspricht der Anzahl der Einträge in bindGroup mit hasDynamicOffset: true.
• Für bindGroup-Einträge, bei denen der gebundene buffer-type "uniform" ist (siehe GPUDevice.createBindGroupLayout()), ist jede Zahl in dynamicOffsets ein Vielfaches der minUniformBufferOffsetAlignment-Grenze des GPUDevice.
• Für bindGroup-Einträge, bei denen der gebundene buffer-type "storage" oder "read-only-storage" ist (siehe GPUDevice.createBindGroupLayout()), ist jede Zahl in dynamicOffsets ein Vielfaches der minStorageBufferOffsetAlignment-Grenze des GPUDevice.
• Für jeden bindGroup-Eintrag ist der gebundene buffer-offset, plus die minBindingSize des entsprechenden Layout-Eintrags, plus der entsprechende dynamische Versatz, der in dynamicOffsets angegeben ist, kleiner oder gleich der size des gebundenen buffer.

Beispiele

Bind-Gruppe setzen

In unserem grundlegenden Compute-Demo werden mehrere Befehle über einen GPUCommandEncoder aufgezeichnet. Die meisten dieser Befehle stammen vom GPUComputePassEncoder, der durch beginComputePass() erstellt wurde. Der hier verwendete setBindGroup()-Aufruf ist die einfachste Form, bei der nur Index und Bind-Gruppe angegeben werden.

const BUFFER_SIZE = 1000;

// …

// Create GPUCommandEncoder to encode commands to issue to the GPU
const commandEncoder = device.createCommandEncoder();

// Initiate render 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()]);

// …

Bind-Gruppe aufheben

// Set bind group in slot 0
passEncoder.setBindGroup(0, bindGroup);

// Later, unset bind group in slot 0
passEncoder.setBindGroup(0, null);

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Die WebGPU API