Enum BufferUsage 

pub enum BufferUsage {
    MapRead,
    MapWrite,
    CopySource,
    CopyDestination,
    Index,
    Vertex,
    Uniform,
    Storage,
    Indirect,
    QueryResolve,
}

One legal use of a GPU buffer, as declared in GpuBufferDescriptor.usage.

The WebGPU buffer usage field is a bitmask, not an enum: a buffer may be used for several purposes at once. This enum names the individual bits so call sites never hand-write a magic number, and the renderer ORs the selected variants into the bitmask at the call site. Combine bits with |, e.g. BufferUsage::Vertex | BufferUsage::CopyDestination.

Variants

MapRead

The buffer may be mapped for reading from the CPU.

Implies the buffer is host-visible, so it cannot be combined with most other uses on conformant implementations.

MapWrite

The buffer may be mapped for writing from the CPU.

CopySource

The buffer may be the source of a copyBufferToBuffer / copyTextureToBuffer call.

CopyDestination

The buffer may be the destination of a copyBufferToBuffer call or of queue.writeBuffer.

Index

The buffer holds an index list for setIndexBuffer and drawIndexed.

Vertex

The buffer holds per-vertex or per-instance attributes for setVertexBuffer.

Uniform

The buffer is bound as a var<uniform> in WGSL.

Storage

The buffer is bound as a var<storage> in WGSL.

Indirect

The buffer holds the arguments of an indirect draw or dispatch.

QueryResolve

The buffer is the destination of commandEncoder.resolveQuerySet.

Implementations

impl BufferUsage

The GPUBufferUsage bit one use occupies.

The canonical WebGPU values, in one place: a buffer’s legal uses are a GPUTextureUsage-style bitmask, and getting a bit wrong produces a buffer that validates in some draws and silently loses the access in others. Keeping the table on the enum itself means a call site cannot reference a stale duplicate constant.

pub fn usage_bit(self) -> u32

The GPUBufferUsage bit this use occupies.

Returns

• u32 - The bit this use occupies in a GpuBufferDescriptor usage; combine several with |.

Trait Implementations

impl BitOr for BufferUsage

Combines two buffer uses into the bitmask a GpuBufferDescriptor expects.

A buffer may be used for several purposes at once, and the WebGPU usage field is a bitmask rather than an enum, so combining uses is the normal case rather than the exception. The | operator is the only way the engine combines them, which keeps every bit value in exactly one place.

type Output = u32

The combined usage bitmask.

fn bitor(self, rhs: Self) -> Self::Output

Combines two buffer uses into their usage bitmask.

Arguments

• Self - The right-hand use.

Returns

• Self::Output - The bitmask carrying both uses.

impl Clone for BufferUsage

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BufferUsage

impl Debug for BufferUsage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for BufferUsage

impl Hash for BufferUsage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BufferUsage

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BufferUsage