WebGPU API
The mapState read-only property of the
GPUBuffer interface represents the mapped state of the GPUBuffer.
Value
An enumerated value. Possible values are:
unmapped- : The buffer is not mapped. GPUBuffer.getMappedRange() cannot be used to access the contents of the
GPUBufferin JavaScript. This could be because:- GPUBuffer.mapAsync() has not yet been called.
- The
GPUBufferwas previously mapped, and then unmapped again with GPUBuffer.unmap().
- : The buffer is not mapped. GPUBuffer.getMappedRange() cannot be used to access the contents of the
pending- : The buffer is not yet mapped. GPUBuffer.mapAsync() has been called, but its Promise is currently pending. GPUBuffer.getMappedRange() cannot currently be used to access the contents of the
GPUBufferin JavaScript.
- : The buffer is not yet mapped. GPUBuffer.mapAsync() has been called, but its Promise is currently pending. GPUBuffer.getMappedRange() cannot currently be used to access the contents of the
mapped- : The buffer is mapped. The GPUBuffer.mapAsync() Promise has fulfilled, and GPUBuffer.getMappedRange() can now be used to access the contents of the
GPUBufferin JavaScript.
- : The buffer is mapped. The GPUBuffer.mapAsync() Promise has fulfilled, and GPUBuffer.getMappedRange() can now be used to access the contents of the
Examples
const stagingBuffer = device.createBuffer({
size: BUFFER_SIZE,
usage: GPUBufferUsage.MAP_READ | GPUBufferUsage.COPY_DST,
});
console.log(stagingBuffer.mapState); // "unmapped"
// …
await stagingBuffer.mapAsync(
GPUMapMode.READ,
0, // Offset
BUFFER_SIZE, // Length
);
console.log(stagingBuffer.mapState); // "mapped"
Specifications
Browser compatibility
See also
- The WebGPU API
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
