Class Storage

A GPU storage object that can be used in a BindGroup.

Hierarchy

components
- Storage

Index

Constructors

Properties

_device? binding bufferOptions canvas? canvasFormat context? cpuBuffer? gpuBuffer? label? usage visibility

Methods

getDevice setCanvas setCpuBuffer setDevice setLabel updateGpuBuffer

Constructors

constructor

new Storage(options): Storage
Parameters
- options: StorageOptions
Returns Storage
Overrides components.constructor
- Defined in Storage.ts:43

Properties

`Optional` _device

_device?: GPUDevice

binding

binding: number

`Readonly` bufferOptions

bufferOptions: {
type: "storage" | "read-only-storage";
}

Type declaration

type: "storage" | "read-only-storage"

`Optional` canvas

canvas?: HTMLCanvasElement

canvasFormat

canvasFormat: GPUTextureFormat = ...

`Optional` context

context?: GPUCanvasContext

`Optional` cpuBuffer

cpuBuffer?: ArrayType

`Optional` gpuBuffer

gpuBuffer?: GPUBuffer

`Optional` label

label?: string

usage

usage: number = GPUBufferUsage.COPY_DST

`Readonly` visibility

visibility: number

Methods

getDevice

getDevice(): Promise<GPUDevice>
Returns Promise<GPUDevice>
Inherited from components.getDevice
- Defined in components/Device.ts:11

setCanvas

setCanvas(canvas): void
Parameters
- canvas: HTMLCanvasElement
Returns void
Inherited from components.setCanvas
- Defined in components/Canvas.ts:10

setCpuBuffer

setCpuBuffer(buffer): Promise<void>
Parameters
- buffer: ArrayType
Returns Promise<void>
Overrides components.setCpuBuffer
- Defined in Storage.ts:55

setDevice

setDevice(d): void
Parameters
- d: GPUDevice
Returns void
Inherited from components.setDevice
- Defined in components/Device.ts:21

setLabel

setLabel(label): void
Parameters
- label: string
Returns void
Inherited from components.setLabel
- Defined in components/Label.ts:10

updateGpuBuffer

updateGpuBuffer(): Promise<void>
Returns Promise<void>
- Defined in Storage.ts:60

Generated using TypeDoc