GPUBuffer

open class GPUBuffer : GPUObjectBase(source)

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

Properties

label

open var label: String

MDN Reference

mapState

val mapState: GPUBufferMapState

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

size

val size: GPUSize64Out

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

usage

val usage: GPUFlagsConstant

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

Functions

destroy

fun destroy()

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

getMappedRange

fun getMappedRange(offset: GPUSize64 = definedExternally, size: GPUSize64 = definedExternally): ArrayBuffer

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

map

inline suspend fun GPUBuffer.map(mode: GPUMapModeFlags)

inline suspend fun GPUBuffer.map(mode: GPUMapModeFlags, offset: GPUSize64)

inline suspend fun GPUBuffer.map(mode: GPUMapModeFlags, offset: GPUSize64, size: GPUSize64)

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.

mapAsync

fun mapAsync(mode: GPUMapModeFlags, offset: GPUSize64 = definedExternally, size: GPUSize64 = definedExternally): Promise<Void?>

unmap

fun unmap()

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).