GPUCommandEncoder

Limited availability

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

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 GPUCommandEncoder-Schnittstelle der WebGPU-API repräsentiert einen Kommando-Encoder, der verwendet wird, um Befehle zu kodieren, die an die GPU gesendet werden sollen.

Ein GPUCommandEncoder-Objekt wird über die GPUDevice.createCommandEncoder()-Eigenschaft erstellt.

Instanzeigenschaften

label

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

Instanzmethoden

beginComputePass()

Beginnt die Kodierung eines Compute-Passes und gibt einen GPUComputePassEncoder zurück, der zur Steuerung der Berechnung verwendet werden kann.

beginRenderPass()

Beginnt die Kodierung eines Render-Passes und gibt einen GPURenderPassEncoder zurück, der zur Steuerung des Renderns verwendet werden kann.

clearBuffer()

Kodiert einen Befehl, der einen Bereich eines GPUBuffer mit Nullen füllt.

copyBufferToBuffer()

Kodiert einen Befehl, der Daten von einem GPUBuffer zu einem anderen kopiert.

copyBufferToTexture()

Kodiert einen Befehl, der Daten von einem GPUBuffer zu einer GPUTexture kopiert.

copyTextureToBuffer()

Kodiert einen Befehl, der Daten von einer GPUTexture zu einem GPUBuffer kopiert.

copyTextureToTexture()

Kodiert einen Befehl, der Daten von einer GPUTexture zu einer anderen kopiert.

finish()

Schließt die Aufzeichnung der Befehlssequenz ab, die auf diesem GPUCommandEncoder kodiert wurde, und gibt einen entsprechenden GPUCommandBuffer zurück.

insertDebugMarker()

Markiert einen bestimmten Punkt in einer Serie kodierter Befehle mit einem Label.

popDebugGroup()

Beendet eine Debug-Gruppe, die mit einem pushDebugGroup()-Aufruf begonnen wurde.

pushDebugGroup()

Beginnt eine Debug-Gruppe, die mit einem bestimmten Label markiert ist und alle nachfolgenden kodierten Befehle bis zum Aufruf der Methode popDebugGroup() enthält.

resolveQuerySet()

Kodiert einen Befehl, der einen GPUQuerySet auflöst, wobei die Ergebnisse in einen angegebenen GPUBuffer kopiert werden.

writeTimestamp() Nicht standardisiert Veraltet

Kodiert einen Befehl, der einen Zeitstempel in einen GPUQuerySet schreibt, nachdem die vorherigen Befehle, die in den gleichen gequeueten GPUCommandBuffer aufgenommen wurden, von der GPU ausgeführt wurden.

Beispiele

In unserem grundlegenden Render-Demo werden mehrere Befehle über einen GPUCommandEncoder aufgezeichnet:

js
// …

// Create GPUCommandEncoder
const commandEncoder = device.createCommandEncoder();

// Create GPURenderPassDescriptor to tell WebGPU which texture to draw into, then initiate render pass

const renderPassDescriptor = {
  colorAttachments: [
    {
      clearValue: clearColor,
      loadOp: "clear",
      storeOp: "store",
      view: context.getCurrentTexture().createView(),
    },
  ],
};

const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

// Draw a triangle

passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.draw(3);

// End the render pass

passEncoder.end();

// …

Die durch den GPUCommandEncoder kodierten Befehle werden mithilfe der Methode GPUCommandEncoder.finish() in einen GPUCommandBuffer aufgenommen. Der Befehls-Puffer wird dann über einen submit()-Aufruf in die Warteschlange gestellt und ist bereit, von der GPU verarbeitet zu werden.

js
device.queue.submit([commandEncoder.finish()]);

Hinweis: Studieren Sie die WebGPU-Beispiele, um mehr Beispiele zur Befehlscodierung zu finden.

Spezifikationen

Specification
WebGPU
# gpucommandencoder

Browser-Kompatibilität

Siehe auch