GPUCommandEncoder: clearBuffer()-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 clearBuffer()-Methode der GPUCommandEncoder-Schnittstelle kodiert einen Befehl, der eine Region eines GPUBuffer mit Nullen füllt.

Syntax

js
clearBuffer(buffer)
clearBuffer(buffer, offset)
clearBuffer(buffer, offset, size)

Parameter

buffer

Ein GPUBuffer-Objekt, das den zu löschenden Puffer darstellt.

offset Optional

Eine Zahl, die den Offset in Bytes vom Anfang des buffer zur zu löschenden Teilregion darstellt. Wird offset ausgelassen, wird standardmäßig 0 verwendet.

size Optional

Eine Zahl, die die Größe in Bytes der zu löschenden Teilregion darstellt. Wird size ausgelassen, wird standardmäßig die Größe von buffer - offset verwendet.

Rückgabewert

Keiner (Undefined).

Validierung

Die folgenden Kriterien müssen erfüllt sein, wenn clearBuffer() aufgerufen wird, sonst wird ein GPUValidationError generiert und der GPUCommandEncoder wird ungültig:

  • Die GPUBuffer.usage des buffer umfasst das GPUBufferUsage.COPY_DST-Flag.
  • offset und size sind beide Vielfache von 4.
  • Die GPUBuffer.size des buffer ist größer oder gleich offset + size.

Beispiele

js
// ...

const buffer = device.createBuffer({
  size: 1000,
  usage: GPUBufferUsage.MAP_READ | GPUBufferUsage.COPY_DST,
});

// Later on

const commandBuffer = device.createCommandEncoder();
commandEncoder.clearBuffer(buffer);

// ...

Spezifikationen

Specification
WebGPU
# dom-gpucommandencoder-clearbuffer

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch