Struct wgpu_types::BufferUsages
source · pub struct BufferUsages(/* private fields */);
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
impl BufferUsages
sourcepub const MAP_READ: Self = _
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.
sourcepub const MAP_WRITE: Self = _
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.
sourcepub const COPY_SRC: Self = _
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.
sourcepub const COPY_DST: Self = _
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.
sourcepub const UNIFORM: Self = _
pub const UNIFORM: Self = _
Allow a buffer to be a BufferBindingType::Uniform
inside a bind group.
sourcepub const STORAGE: Self = _
pub const STORAGE: Self = _
Allow a buffer to be a BufferBindingType::Storage
inside a bind group.
sourcepub const INDIRECT: Self = _
pub const INDIRECT: Self = _
Allow a buffer to be the indirect buffer in an indirect draw call.
sourcepub const QUERY_RESOLVE: Self = _
pub const QUERY_RESOLVE: Self = _
Allow a buffer to be the destination buffer for a [CommandEncoder::resolve_query_set
] operation.
source§impl BufferUsages
impl BufferUsages
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl BufferUsages
impl BufferUsages
sourcepub const fn iter(&self) -> Iter<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.
sourcepub const fn iter_names(&self) -> IterNames<BufferUsages>
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.
source§impl BufferUsages
impl BufferUsages
sourcepub fn contains_invalid_bits(&self) -> bool
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
impl Binary for BufferUsages
source§impl BitAnd for BufferUsages
impl BitAnd for BufferUsages
source§impl BitAndAssign for BufferUsages
impl BitAndAssign for BufferUsages
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for BufferUsages
impl BitOr for BufferUsages
source§fn bitor(self, other: BufferUsages) -> Self
fn bitor(self, other: BufferUsages) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = BufferUsages
type Output = BufferUsages
|
operator.source§impl BitOrAssign for BufferUsages
impl BitOrAssign for BufferUsages
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for BufferUsages
impl BitXor for BufferUsages
source§impl BitXorAssign for BufferUsages
impl BitXorAssign for BufferUsages
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for BufferUsages
impl Clone for BufferUsages
source§fn clone(&self) -> BufferUsages
fn clone(&self) -> BufferUsages
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for BufferUsages
impl Debug for BufferUsages
source§impl Extend<BufferUsages> for BufferUsages
impl Extend<BufferUsages> for BufferUsages
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for BufferUsages
impl Flags for BufferUsages
source§const FLAGS: &'static [Flag<BufferUsages>] = _
const FLAGS: &'static [Flag<BufferUsages>] = _
source§fn from_bits_retain(bits: u32) -> BufferUsages
fn from_bits_retain(bits: u32) -> BufferUsages
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<BufferUsages> for BufferUsages
impl FromIterator<BufferUsages> for BufferUsages
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for BufferUsages
impl Hash for BufferUsages
source§impl IntoIterator for BufferUsages
impl IntoIterator for BufferUsages
source§impl LowerHex for BufferUsages
impl LowerHex for BufferUsages
source§impl Not for BufferUsages
impl Not for BufferUsages
source§impl Octal for BufferUsages
impl Octal for BufferUsages
source§impl PartialEq for BufferUsages
impl PartialEq for BufferUsages
source§fn eq(&self, other: &BufferUsages) -> bool
fn eq(&self, other: &BufferUsages) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for BufferUsages
impl PublicFlags for BufferUsages
source§impl Sub for BufferUsages
impl Sub for BufferUsages
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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
type Output = BufferUsages
-
operator.source§impl SubAssign for BufferUsages
impl SubAssign for BufferUsages
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.