GPUBuffer: getMappedRange() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("WebGPU API")}}{{SecureContext_Header}}{{AvailableInWorkers}}
The **getMappedRange()** method of the {{domxref("GPUBuffer")}} interface returns an {{jsxref("ArrayBuffer")}} containing the mapped contents of the GPUBuffer in the specified range.
This can only happen once the GPUBuffer has been successfully mapped with {{domxref("GPUBuffer.mapAsync()")}} (this can be checked via {{domxref("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 {{domxref("GPUBuffer.unmap()")}} to unmap it, making it accessible to the GPU again. A TypeError is thrown if an attempt is made to detach the {{jsxref("ArrayBuffer")}} in any way other than via {{domxref("GPUBuffer.unmap()")}}, such as by calling {{jsxref("ArrayBuffer/transfer", "transfer()")}}.
Syntax
getMappedRange()
getMappedRange(offset)
getMappedRange(offset, size)Parameters
offset{{optional_inline}}- : 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 {{jsxref("ArrayBuffer")}}. Ifoffsetis omitted, it defaults to 0. size{{optional_inline}}- : A number representing the size, in bytes, of the {{jsxref("ArrayBuffer")}} to return. If
sizeis omitted, the range extends to the end of theGPUBuffer's mapped range.
Return value
An {{jsxref("ArrayBuffer")}}.
Validation
The following criteria must be met when calling **getMappedRange()**, otherwise an OperationError {{domxref("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 {{jsxref("ArrayBuffer")}} ranges specified by any other active
getMappedRange()calls.
Examples
See the [main GPUBuffer page](/en-US/docs/Web/API/GPUBuffer#examples) for an example.
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- The WebGPU API