GPUBuffer

The GPUBuffer interface of the WebGPU API represents a block of memory that can be used to store raw data to use in GPU operations. Available only in secure contexts.

MDN Reference

Extends

• GPUObjectBase

Methods

destroy()

destroy(): void;

The destroy() method of the GPUBuffer interface destroys the GPUBuffer.

MDN Reference

Returns

void

---

getMappedRange()

getMappedRange(offset?, size?): ArrayBuffer;

The getMappedRange() method of the GPUBuffer interface returns an ArrayBuffer containing the mapped contents of the GPUBuffer in the specified range.

MDN Reference

Parameters

Parameter	Type
offset?	number
size?	number

Returns

ArrayBuffer

---

mapAsync()

mapAsync(
   mode, 
   offset?, 
   size?
): Promise<void>;

The mapAsync() method of the GPUBuffer interface maps the specified range of the GPUBuffer. It returns a Promise that resolves when the GPUBuffer's content is ready to be accessed. While the GPUBuffer is mapped it cannot be used in any GPU commands.

MDN Reference

Parameters

Parameter	Type
mode	number
offset?	number
size?	number

Returns

Promise<void>

---

unmap()

unmap(): void;

The unmap() method of the GPUBuffer interface unmaps the mapped range of the GPUBuffer, making its contents available for use by the GPU again after it has previously been mapped with GPUBuffer.mapAsync() (the GPU cannot access a mapped GPUBuffer).

MDN Reference

Returns

void

Properties

label

label: string;

MDN Reference

Inherited from

GPUObjectBase.label

---

mapState

readonly mapState: GPUBufferMapState;

The mapState read-only property of the GPUBuffer interface represents the mapped state of the GPUBuffer.

MDN Reference

---

size

readonly size: number;

The size read-only property of the GPUBuffer interface represents the length of the GPUBuffer's memory allocation, in bytes.

MDN Reference

---

usage

readonly usage: number;

The usage read-only property of the GPUBuffer interface contains the bitwise flags representing the allowed usages of the GPUBuffer.

MDN Reference