Interface BufferParams

Parameters used to create a Buffer.

interface BufferParams {
    size?: number;
    label?: string;
    usage?: BufferUsageKeys[];
    mappedAtCreation?: boolean;
}

Hierarchy

Partial<Omit<GPUBufferDescriptor, "usage">>
- BufferParams

Index

Properties

size? label? usage? mappedAtCreation?

Properties

`Optional`size

size?: number

The size of the buffer in bytes.

`Optional`label

label?: string

The label of the GPUBuffer, useful for debugging purpose.

`Optional`usage

usage?: BufferUsageKeys[]

Allowed usages for the GPUBuffer as an array of buffer usages names

`Optional`mappedAtCreation

mappedAtCreation?: boolean

Whether to create the GPUBuffer in an already mapped state. See mappedAtCreation (WebGPU API reference).