@tmrw-realityos/charm

---

@tmrw-realityos/charm / WebGPUBuffer

Class: WebGPUBuffer

Defined in: packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:27

Constructors

Constructor

new WebGPUBuffer(device, name?): WebGPUBuffer

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

Parameters

device

GPUDevice

name?

string

Returns

WebGPUBuffer

Properties

data?

optional data: ArrayBuffer | TypedArray

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 Signature

get buffer(): GPUBuffer

Defined in: packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:150

Returns

GPUBuffer

Methods

allocateBuffer()

allocateBuffer(sizeInBytes, usage): GPUBuffer

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

Parameters

sizeInBytes

number

usage

number

Returns

GPUBuffer

---

allocateBufferFromData()

allocateBufferFromData(data, usage): GPUBuffer

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

Parameters

data

TypedArray

usage

number

Returns

GPUBuffer

---

allocateElementBufferFromData()

allocateElementBufferFromData(data, isStatic): void

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

Parameters

data

TypedArray

isStatic

boolean = false

Returns

void

---

allocateStagingBuffer()

allocateStagingBuffer(byteLength): void

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

Parameters

byteLength

number

Returns

void

---

allocateStorageBuffer()

allocateStorageBuffer(sizeInBytes): void

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

Parameters

sizeInBytes

number

Returns

void

---

allocateStorageBufferFromData()

allocateStorageBufferFromData(data, isStatic): void

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

Parameters

data

TypedArray

isStatic

boolean = false

Returns

void

---

allocateUniformBuffer()

allocateUniformBuffer(sizeInBytes): void

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

Parameters

sizeInBytes

number

Returns

void

---

allocateUniformBufferFromData()

allocateUniformBufferFromData(data): void

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

Parameters

data

TypedArray

Returns

void

---

allocateVertexBuffer()

allocateVertexBuffer(sizeInBytes): void

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

Parameters

sizeInBytes

number

Returns

void

---

allocateVertexBufferFromData()

allocateVertexBufferFromData(data, isStatic): void

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

Parameters

data

TypedArray

isStatic

boolean = false

Returns

void

---

destroy()

destroy(): void

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

Destroy the underlying GPUBuffer resource.

Returns

void

---

getSizeInBytes()

getSizeInBytes(): number

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

Returns

number

---

hasBuffer()

hasBuffer(): boolean

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

Returns

boolean

---

mapBuffer()

mapBuffer(mode): Promise<undefined | ArrayBuffer>

Defined in: packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:175

Parameters

mode

number

Returns

Promise<undefined | ArrayBuffer>

---

unmapBuffer()

unmapBuffer(): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:180

Returns

void

---

updateBufferData()

updateBufferData(data): void

Defined in: packages/charm/src/graphics/WebGPU/WebGPUBuffer.ts:162

Parameters

data

TypedArray

Returns

void