Struct wgpu::BufferUsages

#[repr(transparent)]
pub struct BufferUsages(_);

Different ways that you can use a buffer.

The usages determine what kind of memory the buffer is allocated from and what actions the buffer can partake in.

Corresponds to WebGPU GPUBufferUsageFlags.

Implementations

impl BufferUsages

pub const MAP_READ: BufferUsages = Self::from_bits_retain(1 << 0)

Allow a buffer to be mapped for reading using [Buffer::map_async] + [Buffer::get_mapped_range]. This does not include creating a buffer with BufferDescriptor::mapped_at_creation set.

If Features::MAPPABLE_PRIMARY_BUFFERS isn’t enabled, the only other usage a buffer may have is COPY_DST.

pub const MAP_WRITE: BufferUsages = Self::from_bits_retain(1 << 1)

Allow a buffer to be mapped for writing using [Buffer::map_async] + [Buffer::get_mapped_range_mut]. This does not include creating a buffer with mapped_at_creation set.

If Features::MAPPABLE_PRIMARY_BUFFERS feature isn’t enabled, the only other usage a buffer may have is COPY_SRC.

pub const COPY_SRC: BufferUsages = Self::from_bits_retain(1 << 2)

Allow a buffer to be the source buffer for a [CommandEncoder::copy_buffer_to_buffer] or [CommandEncoder::copy_buffer_to_texture] operation.

pub const COPY_DST: BufferUsages = Self::from_bits_retain(1 << 3)

Allow a buffer to be the destination buffer for a [CommandEncoder::copy_buffer_to_buffer], [CommandEncoder::copy_texture_to_buffer], [CommandEncoder::clear_buffer] or [Queue::write_buffer] operation.

pub const INDEX: BufferUsages = Self::from_bits_retain(1 << 4)

Allow a buffer to be the index buffer in a draw operation.

pub const VERTEX: BufferUsages = Self::from_bits_retain(1 << 5)

Allow a buffer to be the vertex buffer in a draw operation.

pub const UNIFORM: BufferUsages = Self::from_bits_retain(1 << 6)

Allow a buffer to be a BufferBindingType::Uniform inside a bind group.

pub const STORAGE: BufferUsages = Self::from_bits_retain(1 << 7)

Allow a buffer to be a BufferBindingType::Storage inside a bind group.

pub const INDIRECT: BufferUsages = Self::from_bits_retain(1 << 8)

Allow a buffer to be the indirect buffer in an indirect draw call.

pub const QUERY_RESOLVE: BufferUsages = Self::from_bits_retain(1 << 9)

Allow a buffer to be the destination buffer for a [CommandEncoder::resolve_query_set] operation.

impl BufferUsages

pub const fn empty() -> BufferUsages

Returns an empty set of flags.

pub const fn all() -> BufferUsages

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<BufferUsages>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const fn from_bits_retain(bits: u32) -> BufferUsages

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub fn from_name(name: &str) -> Option<BufferUsages>

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the flag.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

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

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

Inserts the specified flags in-place.

This method is equivalent to union.

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

Removes the specified flags in-place.

This method is equivalent to difference.

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

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

pub fn set(&mut self, other: BufferUsages, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: BufferUsages) -> BufferUsages

Returns the intersection between the flags in self and other.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

pub const fn union(self, other: BufferUsages) -> BufferUsages

Returns the union of between the flags in self and other.

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

pub const fn difference(self, other: BufferUsages) -> BufferUsages

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

pub const fn symmetric_difference(self, other: BufferUsages) -> BufferUsages

Returns the symmetric difference between the flags in self and other.

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

pub const fn complement(self) -> BufferUsages

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

impl BufferUsages

pub const fn iter(&self) -> Iter<BufferUsages>

Iterate over enabled flag values.

pub const fn iter_names(&self) -> IterNames<BufferUsages>

Iterate over enabled flag values with their stringified names.

impl BufferUsages

pub fn contains_invalid_bits(&self) -> bool

Returns true if the bitflags contains bits that are not part of the bitflags definition.

Trait Implementations

impl Binary for BufferUsages

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

Formats the value using the given formatter.

impl BitAnd<BufferUsages> for BufferUsages

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

Returns the intersection between the two sets of flags.

type Output = BufferUsages

The resulting type after applying the & operator.

impl BitAndAssign<BufferUsages> for BufferUsages

fn bitand_assign(&mut self, other: BufferUsages)

Disables all flags disabled in the set.

impl BitOr<BufferUsages> for BufferUsages

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

Returns the union of the two sets of flags.

type Output = BufferUsages

The resulting type after applying the | operator.

impl BitOrAssign<BufferUsages> for BufferUsages

fn bitor_assign(&mut self, other: BufferUsages)

Adds the set of flags.

impl BitXor<BufferUsages> for BufferUsages

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

Returns the left flags, but with all the right flags toggled.

type Output = BufferUsages

The resulting type after applying the ^ operator.

impl BitXorAssign<BufferUsages> for BufferUsages

fn bitxor_assign(&mut self, other: BufferUsages)

Toggles the set of flags.

impl Clone for BufferUsages

fn clone(&self) -> BufferUsages

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BufferUsages

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BufferUsages

Available on crate feature replay only.

fn deserialize<D>( deserializer: D ) -> Result<BufferUsages, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<BufferUsages> for BufferUsages

fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = BufferUsages>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for BufferUsages

const FLAGS: &'static [Flag<BufferUsages>] = &[{ ::bitflags::Flag::new("MAP_READ", BufferUsages::MAP_READ) }, { ::bitflags::Flag::new("MAP_WRITE", BufferUsages::MAP_WRITE) }, { ::bitflags::Flag::new("COPY_SRC", BufferUsages::COPY_SRC) }, { ::bitflags::Flag::new("COPY_DST", BufferUsages::COPY_DST) }, { ::bitflags::Flag::new("INDEX", BufferUsages::INDEX) }, { ::bitflags::Flag::new("VERTEX", BufferUsages::VERTEX) }, { ::bitflags::Flag::new("UNIFORM", BufferUsages::UNIFORM) }, { ::bitflags::Flag::new("STORAGE", BufferUsages::STORAGE) }, { ::bitflags::Flag::new("INDIRECT", BufferUsages::INDIRECT) }, { ::bitflags::Flag::new("QUERY_RESOLVE", BufferUsages::QUERY_RESOLVE) }]

The set of available flags and their names.

type Bits = u32

The underlying storage type.

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

fn from_bits_retain(bits: u32) -> BufferUsages

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

fn from_name(name: &str) -> Option<Self>

Get the flag for a particular name.

fn iter(&self) -> Iter<Self>

Iterate over enabled flag values.

fn iter_names(&self) -> IterNames<Self>

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: Self) -> boolwhere Self: Sized,

Returns true if there are flags common to both self and other.

fn contains(&self, other: Self) -> boolwhere Self: Sized,

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

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place.

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place.

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place.

fn set(&mut self, other: Self, value: bool)where Self: Sized,

Inserts or removes the specified flags depending on the passed value.

fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

fn complement(self) -> Self

Returns the complement of this set of flags.

impl FromIterator<BufferUsages> for BufferUsages

fn from_iter<T>(iterator: T) -> BufferUsageswhere T: IntoIterator<Item = BufferUsages>,

Creates a value from an iterator.

impl Hash for BufferUsages

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 IntoIterator for BufferUsages

type Item = BufferUsages

The type of the elements being iterated over.

type IntoIter = Iter<BufferUsages>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <BufferUsages as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for BufferUsages

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

Formats the value using the given formatter.

impl Not for BufferUsages

fn not(self) -> BufferUsages

Returns the complement of this set of flags.

type Output = BufferUsages

The resulting type after applying the ! operator.

impl Octal for BufferUsages

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

Formats the value using the given formatter.

impl PartialEq<BufferUsages> for BufferUsages

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BufferUsages

Available on crate feature trace only.

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<BufferUsages> for BufferUsages

fn sub(self, other: BufferUsages) -> BufferUsages

Returns the set difference of the two sets of flags.

type Output = BufferUsages

The resulting type after applying the - operator.

impl SubAssign<BufferUsages> for BufferUsages

fn sub_assign(&mut self, other: BufferUsages)

Disables all flags enabled in the set.

impl UpperHex for BufferUsages

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

Formats the value using the given formatter.

impl Copy for BufferUsages

impl Eq for BufferUsages

impl StructuralEq for BufferUsages

impl StructuralPartialEq for BufferUsages