WebGPU API
The getMappedRange() method of the
GPUBuffer interface returns an ArrayBuffer containing the mapped contents of the GPUBuffer in the specified range.
This can only happen once the GPUBuffer has been successfully mapped with GPUBuffer.mapAsync() (this can be checked via GPUBuffer.mapState). While the GPUBuffer is mapped it cannot be used in any GPU commands.
When you have finished working with the GPUBuffer values, call GPUBuffer.unmap() to unmap it, making it accessible to the GPU again. A TypeError is thrown if an attempt is made to detach the ArrayBuffer in any way other than via GPUBuffer.unmap(), such as by calling ArrayBuffer/transfer.
Syntax
getMappedRange()
getMappedRange(offset)
getMappedRange(offset, size)
Parameters
offset- : A number representing the offset, in bytes, from the start of the
GPUBuffer's mapped range to the start of the range to be returned in the ArrayBuffer. Ifoffsetis omitted, it defaults to 0.
- : A number representing the offset, in bytes, from the start of the
size- : A number representing the size, in bytes, of the ArrayBuffer to return. If
sizeis omitted, the range extends to the end of theGPUBuffer's mapped range.
- : A number representing the size, in bytes, of the ArrayBuffer to return. If
Return value
An ArrayBuffer.
Validation
The following criteria must be met when calling getMappedRange(), otherwise an OperationError DOMException is thrown:
offsetis a multiple of 8.- The total range to be mapped (
sizeif specified, or mapped range length -offsetif not) is a multiple of 4. - The total range is inside the bounds of the mapped range and does not overlap with the ArrayBuffer ranges specified by any other active
getMappedRange()calls.
Examples
See the main GPUBuffer page for an example.
Specifications
Browser compatibility
See also
- The WebGPU API
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
