Class StorageBuffer

Hierarchy

GpuBuffer
- StorageBuffer

Index

Constructors

Properties

buffer byteLength device label queue usage

Accessors

Methods

destroy read readAs write writeFromArrayBuffer writeFromWasmMemory

Constructors

constructor

new StorageBuffer(
    device: GPUDevice,
    queue: GPUQueue,
    desc: StorageBufferDescriptor,
): StorageBuffer
Parameters
- device: GPUDevice
- queue: GPUQueue
- desc: StorageBufferDescriptor
Returns StorageBuffer
Overrides GpuBuffer.constructor
- Defined in compute/buffer.ts:84

Properties

`Readonly`buffer

buffer: GPUBuffer

`Readonly`byteLength

byteLength: number

`Readonly`device

device: GPUDevice

`Readonly`label

label: string | null

`Readonly`queue

queue: GPUQueue

`Readonly`usage

usage: number

Accessors

canReadback

get canReadback(): boolean
Returns boolean
- Defined in compute/buffer.ts:109

Methods

destroy

destroy(): void
Returns void
Inherited from GpuBuffer.destroy
- Defined in compute/buffer.ts:54

read

read(srcOffsetBytes?: number, sizeBytes?: number): Promise<ArrayBuffer>
Parameters
- srcOffsetBytes: number = 0
- OptionalsizeBytes: number
Returns Promise<ArrayBuffer>
- Defined in compute/buffer.ts:113

readAs

readAs<T extends ArrayBufferView<ArrayBuffer>>(
    ctor: TypedArrayConstructor<T>,
    srcOffsetBytes?: number,
    sizeBytes?: number,
): Promise<T>
Type Parameters
- T extends ArrayBufferView<ArrayBuffer>
Parameters
- ctor: TypedArrayConstructor<T>
- srcOffsetBytes: number = 0
- OptionalsizeBytes: number
Returns Promise<T>
- Defined in compute/buffer.ts:137

write

write(
    data: BufferSource,
    dstOffsetBytes?: number,
    srcOffsetBytes?: number,
    sizeBytes?: number,
): void
Parameters
- data: BufferSource
- dstOffsetBytes: number = 0
- srcOffsetBytes: number = 0
- OptionalsizeBytes: number
Returns void
Inherited from GpuBuffer.write
- Defined in compute/buffer.ts:58

writeFromArrayBuffer

writeFromArrayBuffer(
    src: ArrayBuffer,
    srcOffsetBytes: number,
    sizeBytes: number,
    dstOffsetBytes?: number,
): void
Parameters
- src: ArrayBuffer
- srcOffsetBytes: number
- sizeBytes: number
- dstOffsetBytes: number = 0
Returns void
Inherited from GpuBuffer.writeFromArrayBuffer
- Defined in compute/buffer.ts:62

writeFromWasmMemory

writeFromWasmMemory(
    mem: Memory,
    srcPtrBytes: number,
    sizeBytes: number,
    dstOffsetBytes?: number,
): void
Parameters
- mem: Memory
- srcPtrBytes: number
- sizeBytes: number
- dstOffsetBytes: number = 0
Returns void
Inherited from GpuBuffer.writeFromWasmMemory
- Defined in compute/buffer.ts:66