GPUBuffer: mapAsync() 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 mapAsync() Methode der GPUBuffer Schnittstelle mappt den angegebenen Bereich des GPUBuffer. Sie gibt ein Promise zurück, das aufgelöst wird, wenn der Inhalt des GPUBuffer bereit ist, um darauf zugegriffen zu werden. Während der GPUBuffer gemappt ist, kann er in keinen GPU-Befehlen verwendet werden.

Sobald der Puffer erfolgreich gemappt wurde (was über GPUBuffer.mapState überprüft werden kann), geben Aufrufe von GPUBuffer.getMappedRange() ein ArrayBuffer zurück, das die aktuellen Werte des GPUBuffer enthält, um von JavaScript bei Bedarf gelesen und aktualisiert zu werden.

Wenn Sie die Arbeit mit den GPUBuffer-Werten beendet haben, rufen Sie GPUBuffer.unmap() auf, um ihn zu entmappen und wieder für die GPU zugänglich zu machen.

Syntax

js
mapAsync(mode)
mapAsync(mode, offset, size)

Parameter

mode

Ein bitweises Flag, das angibt, ob der GPUBuffer zum Lesen oder Schreiben gemappt wird. Mögliche Werte sind:

GPUMapMode.READ

Der GPUBuffer ist zum Lesen gemappt. Werte können gelesen werden, aber alle Änderungen, die am ArrayBuffer vorgenommen werden, das von GPUBuffer.getMappedRange() zurückgegeben wird, werden verworfen, sobald GPUBuffer.unmap() aufgerufen wird.

Das Mapping im Lesemodus kann nur auf GPUBuffers verwendet werden, die die Nutzung GPUBufferUsage.MAP_READ auf ihnen gesetzt haben (d.h. wenn sie mit GPUDevice.createBuffer() erstellt wurden).

GPUMapMode.WRITE

Der GPUBuffer ist zum Schreiben gemappt. Werte können gelesen und aktualisiert werden — alle Änderungen, die am ArrayBuffer vorgenommen werden, das von GPUBuffer.getMappedRange() zurückgegeben wird, werden im GPUBuffer gespeichert, sobald GPUBuffer.unmap() aufgerufen wird.

Das Mapping im Schreibmodus kann nur auf GPUBuffers verwendet werden, die die Nutzung GPUBufferUsage.MAP_WRITE auf ihnen gesetzt haben (d.h. wenn sie mit GPUDevice.createBuffer() erstellt wurden).

offset Optional

Eine Zahl, die den Offset in Bytes vom Anfang des Puffers bis zum Anfang des zu mappenden Bereichs repräsentiert. Wenn offset weggelassen wird, ist der Standardwert 0.

size Optional

Eine Zahl, die die Größe in Bytes des zu mappenden Bereichs repräsentiert. Wenn size weggelassen wird, erstreckt sich der gemappte Bereich bis zum Ende des GPUBuffer.

Rückgabewert

Ein Promise, das auf Undefined aufgelöst wird, wenn der Inhalt des GPUBuffer bereit ist, um darauf zugegriffen zu werden.

Validierung

Die folgenden Kriterien müssen erfüllt sein, wenn mapAsync() aufgerufen wird, andernfalls wird ein OperationError DOMException ausgelöst, das Promise wird abgelehnt, und ein GPUValidationError wird generiert:

  • offset ist ein Vielfaches von 8.
  • Der gesamte zu mappende Bereich (size, falls angegeben, oder GPUBuffer.size - offset, falls nicht) ist ein Vielfaches von 4.
  • Der gesamte zu mappende Bereich liegt innerhalb der Grenzen des GPUBuffer.
  • Wenn der Modus GPUMapMode.READ ist, hat der GPUBuffer die Nutzung GPUBufferUsage.MAP_READ.
  • Wenn der Modus GPUMapMode.WRITE ist, hat der GPUBuffer die Nutzung GPUBufferUsage.MAP_WRITE.

Beispiele

Sehen Sie das Hauptseite zu GPUBuffer für ein Beispiel.

Spezifikationen

Specification
WebGPU
# dom-gpubuffer-mapasync

Browser-Kompatibilität

Siehe auch