Type Alias BufferDescriptor

pub type BufferDescriptor<'a> = BufferDescriptor<Option<&'a str>>;

Describes a Buffer.

For use with Device::create_buffer.

Corresponds to WebGPU GPUBufferDescriptor.

Aliased Type

struct BufferDescriptor<'a> {
    pub label: Option<&'a str>,
    pub size: u64,
    pub usage: BufferUsages,
    pub mapped_at_creation: bool,
}

Fields

label: Option<&'a str>

Debug label of a buffer. This will show up in graphics debuggers for easy identification.

size: u64

Size of a buffer, in bytes.

usage: BufferUsages

Usages of a buffer. If the buffer is used in any way that isn’t specified here, the operation will panic.

mapped_at_creation: bool

Allows a buffer to be mapped immediately after they are made. It does not have to be [BufferUsages::MAP_READ] or [BufferUsages::MAP_WRITE], all buffers are allowed to be mapped at creation.

If this is true, size must be a multiple of [COPY_BUFFER_ALIGNMENT].