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 Group 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 Berechnungsbefehle verwendet wird, oder null, in diesem Fall wird jede zuvor gesetzte Bind Group im gegebenen Slot aufgehoben.

dynamicOffsets Optional

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

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

Wenn ein Uint32Array Wert für dynamicOffsets angegeben ist, sind die folgenden Parameter ebenfalls erforderlich:

dynamicOffsetsStart

Eine Zahl, die den Offset in Array-Elementen in dynamicOffsetsData angibt, wo die dynamischen Offset-Daten beginnen.

dynamicOffsetsLength

Eine Zahl, die die Anzahl der dynamischen Offset-Werte angibt, die aus dynamicOffsetsData gelesen werden sollen.

Rückgabewert

Keiner (Undefined).

Ausnahmen

Für setBindGroup() Aufrufe, die einen Uint32Array Wert für dynamicOffsets verwenden, wird der Aufruf einen RangeError DOMException auslösen, 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 dem maxBindGroups Limit des GPUDevice.
• dynamicOffsets.length entspricht der Anzahl der Einträge in bindGroup mit hasDynamicOffset: true gesetzt.
• Für bindGroup-Einträge, bei denen der gebundene buffer's type "uniform" ist (siehe GPUDevice.createBindGroupLayout()), ist jede Zahl in dynamicOffsets ein Vielfaches des minUniformBufferOffsetAlignment Limits des GPUDevice.
• Für bindGroup-Einträge, bei denen der gebundene buffer's type "storage" oder "read-only-storage" ist (siehe GPUDevice.createBindGroupLayout()), ist jede Zahl in dynamicOffsets ein Vielfaches des minStorageBufferOffsetAlignment Limits des GPUDevice.
• Für jeden bindGroup-Eintrag ist der gebundene buffer's offset, plus der entsprechende Layout-Eintrag's minBindingSize, plus der entsprechende dynamische Offset angegeben in dynamicOffsets, kleiner oder gleich der gebundene buffer's size.

Beispiele

Bind Group setzen

In unserem einfachen Berechnungs-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 der Index und die Bind Group angegeben werden.

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

// …

Bind Group 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