Struct BufferUsage

pub struct BufferUsage { /* private fields */ }

A set of flags describing the allowed usages of a BufferId.

These flags are crucial for performance and validation. The graphics driver uses them to place the buffer in the most optimal memory type (e.g., GPU-only vs. CPU-visible) and to validate that the buffer is used correctly at runtime.

Implementations

impl BufferUsage

pub const EMPTY: BufferUsage

An empty set of flags.

pub const MAP_READ: BufferUsage

The buffer can be mapped for reading on the CPU.

pub const MAP_WRITE: BufferUsage

The buffer can be mapped for writing on the CPU.

pub const COPY_SRC: BufferUsage

The buffer can be used as the source of a copy operation.

pub const COPY_DST: BufferUsage

The buffer can be used as the destination of a copy operation.

pub const VERTEX: BufferUsage

The buffer can be bound as a vertex buffer.

pub const INDEX: BufferUsage

The buffer can be bound as an index buffer.

pub const UNIFORM: BufferUsage

The buffer can be bound as a uniform buffer.

pub const STORAGE: BufferUsage

The buffer can be bound as a storage buffer (read/write access from shaders).

pub const INDIRECT: BufferUsage

The buffer can be used for indirect draw or dispatch commands.

pub const QUERY_RESOLVE: BufferUsage

The buffer can be used as a destination for query results.

pub const fn from_bits_truncate(bits: u32) -> BufferUsage

Creates a new bitflag set from the given raw bits. Bits not corresponding to any defined flag are kept.

pub const fn bits(&self) -> u32

Returns the raw value of the bitflag set.

pub const fn contains(&self, other: BufferUsage) -> bool

Returns true if all flags in other are contained within self.

pub const fn intersects(&self, other: BufferUsage) -> bool

Returns true if any flag in other is contained within self.

pub fn insert(&mut self, other: BufferUsage)

Inserts the flags in other into self.

pub fn remove(&mut self, other: BufferUsage)

Removes the flags in other from self.

pub fn toggle(&mut self, other: BufferUsage)

Toggles the flags in other in self.

pub const fn with(self, other: BufferUsage) -> BufferUsage

Returns a new Self with other flags inserted.

pub const fn without(self, other: BufferUsage) -> BufferUsage

Returns a new Self with other flags removed.

Trait Implementations

impl BitAnd for BufferUsage

type Output = BufferUsage

The resulting type after applying the & operator.

fn bitand(self, other: BufferUsage) -> BufferUsage

Performs the & operation.

impl BitAndAssign for BufferUsage

fn bitand_assign(&mut self, other: BufferUsage)

Performs the &= operation.

impl BitOr for BufferUsage

type Output = BufferUsage

The resulting type after applying the | operator.

fn bitor(self, other: BufferUsage) -> BufferUsage

Performs the | operation.

impl BitOrAssign for BufferUsage

fn bitor_assign(&mut self, other: BufferUsage)

Performs the |= operation.

impl BitXor for BufferUsage

type Output = BufferUsage

The resulting type after applying the ^ operator.

fn bitxor(self, other: BufferUsage) -> BufferUsage

Performs the ^ operation.

impl BitXorAssign for BufferUsage

fn bitxor_assign(&mut self, other: BufferUsage)

Performs the ^= operation.

impl Clone for BufferUsage

fn clone(&self) -> BufferUsage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferUsage

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

Formats the value using the given formatter.

impl Default for BufferUsage

fn default() -> BufferUsage

Returns the “default value” for a type.

impl Hash for BufferUsage

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

where __H: Hasher,

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 Not for BufferUsage

type Output = BufferUsage

The resulting type after applying the ! operator.

fn not(self) -> BufferUsage

Performs the unary ! operation.

impl PartialEq for BufferUsage

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BufferUsage

impl Eq for BufferUsage

impl StructuralPartialEq for BufferUsage