Struct wgpu::BufferUsage

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

Methods

impl BufferUsage

pub const MAP_READ: BufferUsage

pub const MAP_WRITE: BufferUsage

pub const COPY_SRC: BufferUsage

pub const COPY_DST: BufferUsage

pub const INDEX: BufferUsage

pub const VERTEX: BufferUsage

pub const UNIFORM: BufferUsage

pub const STORAGE: BufferUsage

pub const STORAGE_READ: BufferUsage

pub const INDIRECT: BufferUsage

pub const NONE: BufferUsage

pub const READ_ALL: BufferUsage

The combination of all read-only usages.

pub const WRITE_ALL: BufferUsage

The combination of all write-only and read-write usages.

pub const ORDERED: BufferUsage

The combination of all usages that the are guaranteed to be be ordered by the hardware. If a usage is not ordered, then even if it doesn't change between draw calls, there still need to be pipeline barriers inserted for synchronization.

pub fn empty() -> BufferUsage

Returns an empty set of flags.

pub fn all() -> BufferUsage

Returns the set containing all flags.

pub 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 fn from_bits_truncate(bits: u32) -> BufferUsage

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

pub 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 BitOrAssign<BufferUsage> for BufferUsage

fn bitor_assign(&mut self, other: BufferUsage)

Adds the set of flags.

impl BitXorAssign<BufferUsage> for BufferUsage

fn bitxor_assign(&mut self, other: BufferUsage)

Toggles the set of flags.

impl SubAssign<BufferUsage> for BufferUsage

fn sub_assign(&mut self, other: BufferUsage)

Disables all flags enabled 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 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 Eq for BufferUsage

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 UpperHex for BufferUsage

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

Formats the value using the given formatter.

impl Binary for BufferUsage

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

Formats the value using the given formatter.

impl BitAndAssign<BufferUsage> for BufferUsage

fn bitand_assign(&mut self, other: BufferUsage)

Disables all flags disabled in the set.

impl LowerHex for BufferUsage

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

Formats the value using the given formatter.

impl PartialEq<BufferUsage> for BufferUsage

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 Octal for BufferUsage

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

Formats the value using the given formatter.

impl FromIterator<BufferUsage> for BufferUsage

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

Creates a value from an iterator.

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

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Debug for BufferUsage

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

Formats the value using the given formatter.

impl Clone for BufferUsage

fn clone(&self) -> BufferUsage

Returns a copy of the value.

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

Performs copy-assignment from source.

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 Copy for BufferUsage

impl Hash for BufferUsage

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 Extend<BufferUsage> for BufferUsage

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

Extends a collection with the contents of an iterator.