Struct wgpu::BufferUsage

[+] Show declaration

[+] Expand attributes
#[repr(transparent)]pub struct BufferUsage { /* fields omitted */ }

[−] 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.

Implementations

impl BufferUsage[−]

pub const MAP_READ: BufferUsage[−][−]

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: BufferUsage[−][−]

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: BufferUsage[−][−]

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: BufferUsage[−][−]

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

pub const INDEX: BufferUsage[−][−]

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

pub const VERTEX: BufferUsage[−][−]

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

pub const UNIFORM: BufferUsage[−][−]

Allow a buffer to be a BindingType::UniformBuffer inside a bind group.

pub const STORAGE: BufferUsage[−][−]

Allow a buffer to be a BindingType::StorageBuffer inside a bind group.

pub const INDIRECT: BufferUsage[−][−]

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

pub const fn empty() -> BufferUsage[−]

Returns an empty set of flags

pub const fn all() -> BufferUsage[−]

Returns the set containing all flags.

pub const fn bits(&self) -> u32[−]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<BufferUsage>[−]

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) -> BufferUsage[−]

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> BufferUsage[−]

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined 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: BufferUsage) -> bool[−]

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

pub fn set(&mut self, other: BufferUsage, value: bool)[−]

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

Trait Implementations

impl Binary for BufferUsage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl BitAnd<BufferUsage> for BufferUsage[+]

type Output = BufferUsage

The resulting type after applying the & operator.

fn bitand(self, other: BufferUsage) -> BufferUsage[−]

Returns the intersection between the two sets of flags.

impl BitAndAssign<BufferUsage> for BufferUsage[+]

fn bitand_assign(&mut self, other: BufferUsage)[−]

Disables all flags disabled in the set.

impl BitOr<BufferUsage> for BufferUsage[+]

type Output = BufferUsage

The resulting type after applying the | operator.

fn bitor(self, other: BufferUsage) -> BufferUsage[−]

Returns the union of the two sets of flags.

impl BitOrAssign<BufferUsage> for BufferUsage[+]

fn bitor_assign(&mut self, other: BufferUsage)[−]

Adds the set of flags.

impl BitXor<BufferUsage> for BufferUsage[+]

type Output = BufferUsage

The resulting type after applying the ^ operator.

fn bitxor(self, other: BufferUsage) -> BufferUsage[−]

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

impl BitXorAssign<BufferUsage> for BufferUsage[+]

fn bitxor_assign(&mut self, other: BufferUsage)[−]

Toggles the set of flags.

impl Clone for BufferUsage[+]

[+] Show hidden undocumented items

fn clone(&self) -> BufferUsage[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for BufferUsage

impl Debug for BufferUsage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for BufferUsage

impl Extend<BufferUsage> for BufferUsage[+]

[+] Show hidden undocumented items

fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = BufferUsage>, [−]

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<BufferUsage> for BufferUsage[+]

[+] Show hidden undocumented items

fn from_iter<T>(iterator: T) -> BufferUsage where
    T: IntoIterator<Item = BufferUsage>, [−]

Creates a value from an iterator.

impl Hash for BufferUsage[+]

[+] Show hidden undocumented items

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, [−]

Feeds a slice of this type into the given Hasher.

impl LowerHex for BufferUsage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Not for BufferUsage[+]

type Output = BufferUsage

The resulting type after applying the ! operator.

fn not(self) -> BufferUsage[−]

Returns the complement of this set of flags.

impl Octal for BufferUsage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Ord for BufferUsage[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &BufferUsage) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[−]

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

Restrict a value to a certain interval.

impl PartialEq<BufferUsage> for BufferUsage[+]

[+] Show hidden undocumented items

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

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

fn ne(&self, other: &BufferUsage) -> bool[−]

This method tests for !=.

impl PartialOrd<BufferUsage> for BufferUsage[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &BufferUsage) -> Option<Ordering>[−]

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

fn lt(&self, other: &BufferUsage) -> bool[−]

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

fn le(&self, other: &BufferUsage) -> bool[−]

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

fn gt(&self, other: &BufferUsage) -> bool[−]

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

fn ge(&self, other: &BufferUsage) -> bool[−]

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

impl StructuralEq for BufferUsage

impl StructuralPartialEq for BufferUsage

impl Sub<BufferUsage> for BufferUsage[+]

type Output = BufferUsage

The resulting type after applying the - operator.

fn sub(self, other: BufferUsage) -> BufferUsage[−]

Returns the set difference of the two sets of flags.

impl SubAssign<BufferUsage> for BufferUsage[+]

fn sub_assign(&mut self, other: BufferUsage)[−]

Disables all flags enabled in the set.

impl UpperHex for BufferUsage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.