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

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§

source§

impl BufferUsages

source

pub const MAP_READ: Self = _

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.

source

pub const MAP_WRITE: Self = _

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.

source

pub const COPY_SRC: Self = _

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

source

pub const COPY_DST: Self = _

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.

source

pub const INDEX: Self = _

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

source

pub const VERTEX: Self = _

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

source

pub const UNIFORM: Self = _

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

source

pub const STORAGE: Self = _

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

source

pub const INDIRECT: Self = _

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

source

pub const QUERY_RESOLVE: Self = _

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

source§

impl BufferUsages

source

pub const fn empty() -> Self

Returns an empty set of flags.

source

pub const fn all() -> Self

Returns the set containing all flags.

source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

source

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

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

source

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

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

source

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

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

source

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

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.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

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

source

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

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

source

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

Inserts the specified flags in-place.

This method is equivalent to union.

source

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

Removes the specified flags in-place.

This method is equivalent to difference.

source

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

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

source

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

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

source

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

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.

source

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

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.

source

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

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).

source

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

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.

source

pub const fn complement(self) -> Self

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.

source§

impl BufferUsages

source

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

Iterate over enabled flag values.

source

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

Iterate over enabled flag values with their stringified names.

source§

impl BufferUsages

source

pub fn contains_invalid_bits(&self) -> bool

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

Trait Implementations§

source§

impl Binary for BufferUsages

source§

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

Formats the value using the given formatter.
source§

impl BitAnd<BufferUsages> for BufferUsages

source§

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

Returns the intersection between the two sets of flags.

§

type Output = BufferUsages

The resulting type after applying the & operator.
source§

impl BitAndAssign<BufferUsages> for BufferUsages

source§

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

source§

impl BitOr<BufferUsages> for BufferUsages

source§

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

Returns the union of the two sets of flags.

§

type Output = BufferUsages

The resulting type after applying the | operator.
source§

impl BitOrAssign<BufferUsages> for BufferUsages

source§

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

source§

impl BitXor<BufferUsages> for BufferUsages

source§

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

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

§

type Output = BufferUsages

The resulting type after applying the ^ operator.
source§

impl BitXorAssign<BufferUsages> for BufferUsages

source§

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

source§

impl Clone for BufferUsages

source§

fn clone(&self) -> BufferUsages

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for BufferUsages

source§

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

Formats the value using the given formatter. Read more
source§

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

Available on crate feature replay only.
source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Extend<BufferUsages> for BufferUsages

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl Flags for BufferUsages

source§

const FLAGS: &'static [Flag<BufferUsages>] = _

The set of available flags and their names.
§

type Bits = u32

The underlying storage type.
source§

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.
source§

fn from_bits_retain(bits: u32) -> BufferUsages

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

fn empty() -> Self

Returns an empty set of flags.
source§

fn all() -> Self

Returns the set containing all flags.
source§

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. Read more
source§

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

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

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

Get the flag for a particular name.
source§

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

Iterate over enabled flag values.
source§

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

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

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.
source§

fn is_all(&self) -> bool

Returns true if all flags are currently set.
source§

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

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

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

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

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

Inserts the specified flags in-place. Read more
source§

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

Removes the specified flags in-place. Read more
source§

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

Toggles the specified flags in-place. Read more
source§

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

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

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

Returns the intersection between the flags in self and other.
source§

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

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

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

Returns the difference between the flags in self and other.
source§

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

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

fn complement(self) -> Self

Returns the complement of this set of flags.
source§

impl FromIterator<BufferUsages> for BufferUsages

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator. Read more
source§

impl Hash for BufferUsages

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for BufferUsages

source§

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

Formats the value using the given formatter.
source§

impl Not for BufferUsages

source§

fn not(self) -> Self

Returns the complement of this set of flags.

§

type Output = BufferUsages

The resulting type after applying the ! operator.
source§

impl Octal for BufferUsages

source§

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

Formats the value using the given formatter.
source§

impl PartialEq<BufferUsages> for BufferUsages

source§

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

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

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.
source§

impl PublicFlags for BufferUsages

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl Serialize for BufferUsages

Available on crate feature trace only.
source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Sub<BufferUsages> for BufferUsages

source§

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

Returns the set difference of the two sets of flags.

§

type Output = BufferUsages

The resulting type after applying the - operator.
source§

impl SubAssign<BufferUsages> for BufferUsages

source§

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

source§

impl UpperHex for BufferUsages

source§

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

Formats the value using the given formatter.
source§

impl Copy for BufferUsages

source§

impl Eq for BufferUsages

source§

impl StructuralEq for BufferUsages

source§

impl StructuralPartialEq for BufferUsages

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<B> BitFlags for Bwhere B: Flags,

§

type Iter = Iter<B>

👎Deprecated: use the Flags trait instead
An iterator over enabled flags in an instance of the type.
§

type IterNames = IterNames<B>

👎Deprecated: use the Flags trait instead
An iterator over the raw names and bits for enabled flags in an instance of the type.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,