Struct wgpu::BufferUsages

pub struct BufferUsages(/* private fields */);

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 = _

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 = _

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 = _

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 = _

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 = _

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

pub const VERTEX: BufferUsages = _

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

pub const UNIFORM: BufferUsages = _

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

pub const STORAGE: BufferUsages = _

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

pub const INDIRECT: BufferUsages = _

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

pub const QUERY_RESOLVE: BufferUsages = _

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

impl BufferUsages

pub const fn empty() -> BufferUsages

Get a flags value with all bits unset.

pub const fn all() -> BufferUsages

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

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

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> BufferUsages

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl BufferUsages

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

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

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

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

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

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

The bitwise and (&) of the bits in two flags values.

type Output = BufferUsages

The resulting type after applying the & operator.

impl BitAndAssign for BufferUsages

fn bitand_assign(&mut self, other: BufferUsages)

The bitwise and (&) of the bits in two flags values.

impl BitOr for BufferUsages

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

The bitwise or (|) of the bits in two flags values.

type Output = BufferUsages

The resulting type after applying the | operator.

impl BitOrAssign for BufferUsages

fn bitor_assign(&mut self, other: BufferUsages)

The bitwise or (|) of the bits in two flags values.

impl BitXor for BufferUsages

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = BufferUsages

The resulting type after applying the ^ operator.

impl BitXorAssign for BufferUsages

fn bitxor_assign(&mut self, other: BufferUsages)

The bitwise exclusive-or (^) of the bits in two flags values.

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 serde 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>,

The bitwise or (|) of the bits in each flags value.

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>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> BufferUsages

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

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

Convert from a bits value.

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

Convert from a bits value, unsetting any unknown bits.

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

Get a flags value with the bits of a flag with the given name set.

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

Yield a set of contained flags values.

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

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<BufferUsages> for BufferUsages

fn from_iter<T>(iterator: T) -> BufferUsages

where T: IntoIterator<Item = BufferUsages>,

The bitwise or (|) of the bits in each flags value.

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

The bitwise negation (!) of the bits in a flags value, truncating the result.

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

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = BufferUsages

The resulting type after applying the - operator.

impl SubAssign for BufferUsages

fn sub_assign(&mut self, other: BufferUsages)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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