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 = Self{ bits: 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{ bits: 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{ bits: 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{ bits: 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{ bits: 1 << 4,}

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

pub const VERTEX: BufferUsages = Self{ bits: 1 << 5,}

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

pub const UNIFORM: BufferUsages = Self{ bits: 1 << 6,}

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

pub const STORAGE: BufferUsages = Self{ bits: 1 << 7,}

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

pub const INDIRECT: BufferUsages = Self{ bits: 1 << 8,}

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

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 unsafe fn from_bits_unchecked(bits: u32) -> BufferUsages

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

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

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

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

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

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> BufferUsages

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

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

fn cmp(&self, other: &BufferUsages) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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

fn partial_cmp(&self, other: &BufferUsages) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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