GPUCommandEncoder: beginComputePass()-Methode

Limited availability

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

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die beginComputePass()-Methode der GPUCommandEncoder-Schnittstelle startet die Codierung eines Compute-Passes und gibt einen GPUComputePassEncoder zurück, der zur Steuerung der Berechnung verwendet werden kann.

Syntax

js
beginComputePass()
beginComputePass(descriptor)

Parameter

descriptor Optional

Ein Objekt, das die folgenden Eigenschaften enthält:

label Optional

Ein String, der ein Label bereitstellt, das beispielsweise in GPUError-Nachrichten oder Konsolenwarnungen zur Identifizierung des Objekts verwendet werden kann.

timestampWrites Optional

Ein Array von Objekten, das definiert, wo und wann Zeitstempel-Abfragewerte für diesen Pass geschrieben werden. Diese Objekte haben die folgenden Eigenschaften:

  • location: Ein enumerierter Wert, der angibt, wann der Zeitstempel ausgeführt wird. Verfügbare Werte sind:
    • "beginning": Der Zeitstempel wird zusammen mit den anderen codierten Befehlen im Compute-Pass ausgeführt, sobald der entsprechende GPUCommandBuffer übermittelt wird.
    • "end": Der Zeitstempel wird als Teil einer separaten Liste von Zeitstempel-Anhängen ausgeführt, sobald der Pass endet.
  • queryIndex: Eine Zahl, die die Indexposition im querySet angibt, an die der Zeitstempel geschrieben wird.
  • querySet: Das GPUQuerySet, in das der Zeitstempel geschrieben wird.

Hinweis: Die timestamp-query-Funktion muss aktiviert sein, um Zeitstempel-Abfragen verwenden zu können.

Rückgabewert

Eine Instanz des GPUComputePassEncoder-Objekts.

Validierung

Die folgenden Kriterien müssen beim Aufrufen von beginComputePass() erfüllt sein, andernfalls wird ein GPUValidationError generiert und ein ungültiger GPUComputePassEncoder zurückgegeben:

  • Die timestamp-query-Funktion ist im GPUDevice aktiviert.
  • Keine zwei timestampWrites-Objekte haben die gleiche location. Dies bedeutet effektiv, dass Sie nur zwei Zeitstempelabfragen pro Render-Pass ausführen können.
  • Für jede Zeitstempel-Abfrage ist der querySet GPUQuerySet.type "timestamp", und der queryIndex-Wert ist kleiner als der GPUQuerySet.count.

Beispiele

In unserem grundlegenden Compute-Demo werden mehrere Befehle über einen GPUCommandEncoder aufgezeichnet. Die meisten dieser Befehle stammen von dem GPUComputePassEncoder, der über beginComputePass() erstellt wird.

js
// …

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

// …

Spezifikationen

Specification
WebGPU
# dom-gpucommandencoder-begincomputepass

Browser-Kompatibilität

Siehe auch