Parameters used to create a Buffer.

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

Hierarchy

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

Properties

size?: number

The size of the buffer in bytes.

mappedAtCreation?: boolean

If true creates the buffer in an already mapped state, allowing GPUBuffer#getMappedRange to be called immediately. It is valid to set GPUBufferDescriptor#mappedAtCreation to true even if GPUBufferDescriptor#usage does not contain GPUBufferUsage#MAP_READ or GPUBufferUsage#MAP_WRITE. This can be used to set the buffer's initial data. Guarantees that even if the buffer creation eventually fails, it will still appear as if the mapped range can be written/read to until it is unmapped.

label?: string

The initial value of GPUObjectBase#label|GPUObjectBase.label.

usage?: BufferUsageKeys[]

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