@tmrw-realityos/charm / Exports / WebGPUBuffer

Class: WebGPUBuffer

Table of contents

Constructors

• constructor

Properties

• data
• device_
• name

Accessors

• buffer

Methods

• allocateBuffer
• allocateBufferFromData
• allocateElementBufferFromData
• allocateStagingBuffer
• allocateStorageBuffer
• allocateStorageBufferFromData
• allocateUniformBuffer
• allocateUniformBufferFromData
• allocateVertexBuffer
• allocateVertexBufferFromData
• destroy
• getSizeInBytes
• mapBuffer
• unmapBuffer
• updateBufferData

Constructors

constructor

• new WebGPUBuffer(device, name?): WebGPUBuffer

Parameters

Name	Type
device	GPUDevice
name?	string

Returns

WebGPUBuffer

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:36

Properties

data

• Optional data: ArrayBuffer

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:31

---

device_

• device_: GPUDevice

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:34

---

name

• Optional name: string

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:32

Accessors

buffer

• get buffer(): GPUBuffer

Returns

GPUBuffer

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:146

Methods

allocateBuffer

▸ allocateBuffer(sizeInBytes, usage): GPUBuffer

Parameters

Name	Type
sizeInBytes	number
usage	number

Returns

GPUBuffer

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:55

---

allocateBufferFromData

▸ allocateBufferFromData(data, usage): GPUBuffer

Parameters

Name	Type
data	TypedArray
usage	number

Returns

GPUBuffer

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:68

---

allocateElementBufferFromData

▸ allocateElementBufferFromData(data, isStatic?): void

Parameters

Name	Type	Default value
data	TypedArray	undefined
isStatic	boolean	false

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:125

---

allocateStagingBuffer

▸ allocateStagingBuffer(byteLength): void

Parameters

Name	Type
byteLength	number

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:109

---

allocateStorageBuffer

▸ allocateStorageBuffer(sizeInBytes): void

Parameters

Name	Type
sizeInBytes	number

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:100

---

allocateStorageBufferFromData

▸ allocateStorageBufferFromData(data, isStatic?): void

Parameters

Name	Type	Default value
data	TypedArray	undefined
isStatic	boolean	false

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:139

---

allocateUniformBuffer

▸ allocateUniformBuffer(sizeInBytes): void

Parameters

Name	Type
sizeInBytes	number

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:86

---

allocateUniformBufferFromData

▸ allocateUniformBufferFromData(data): void

Parameters

Name	Type
data	TypedArray

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:132

---

allocateVertexBuffer

▸ allocateVertexBuffer(sizeInBytes): void

Parameters

Name	Type
sizeInBytes	number

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:93

---

allocateVertexBufferFromData

▸ allocateVertexBufferFromData(data, isStatic?): void

Parameters

Name	Type	Default value
data	TypedArray	undefined
isStatic	boolean	false

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:118

---

destroy

▸ destroy(): void

Destroy the underlying GPUBuffer resource.

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:47

---

getSizeInBytes

▸ getSizeInBytes(): number

Returns

number

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:154

---

mapBuffer

▸ mapBuffer(mode): Promise<undefined | ArrayBuffer>

Parameters

Name	Type
mode	number

Returns

Promise<undefined | ArrayBuffer>

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:171

---

unmapBuffer

▸ unmapBuffer(): void

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:176

---

updateBufferData

▸ updateBufferData(data): void

Parameters

Name	Type
data	TypedArray

Returns

void

Defined in

packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:158