Struct wgpu_types::BufferUsages
source · #[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
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 from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u32) -> Self
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).
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn iter_names(&self) -> IterRaw
pub const fn iter_names(&self) -> IterRaw
Iterate over enabled flag values with their stringified names.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
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
.
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<BufferUsages> for BufferUsages
impl BitAnd<BufferUsages> for BufferUsages
source§impl BitAndAssign<BufferUsages> for BufferUsages
impl BitAndAssign<BufferUsages> for BufferUsages
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitFlags for BufferUsages
impl BitFlags for BufferUsages
§type IterNames = IterRaw
type IterNames = IterRaw
source§fn from_bits(bits: u32) -> Option<BufferUsages>
fn from_bits(bits: u32) -> Option<BufferUsages>
source§fn from_bits_truncate(bits: u32) -> BufferUsages
fn from_bits_truncate(bits: u32) -> BufferUsages
source§fn from_bits_retain(bits: u32) -> BufferUsages
fn from_bits_retain(bits: u32) -> BufferUsages
source§fn iter_names(&self) -> Self::IterNames
fn iter_names(&self) -> Self::IterNames
source§fn intersects(&self, other: BufferUsages) -> bool
fn intersects(&self, other: BufferUsages) -> bool
true
if there are flags common to both self
and other
.source§fn contains(&self, other: BufferUsages) -> bool
fn contains(&self, other: BufferUsages) -> bool
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: BufferUsages)
fn insert(&mut self, other: BufferUsages)
source§fn remove(&mut self, other: BufferUsages)
fn remove(&mut self, other: BufferUsages)
source§fn toggle(&mut self, other: BufferUsages)
fn toggle(&mut self, other: BufferUsages)
source§fn set(&mut self, other: BufferUsages, value: bool)
fn set(&mut self, other: BufferUsages, value: bool)
source§impl BitOr<BufferUsages> for BufferUsages
impl BitOr<BufferUsages> for BufferUsages
source§fn bitor(self, other: BufferUsages) -> Self
fn bitor(self, other: BufferUsages) -> Self
Returns the union of the two sets of flags.
§type Output = BufferUsages
type Output = BufferUsages
|
operator.source§impl BitOrAssign<BufferUsages> for BufferUsages
impl BitOrAssign<BufferUsages> for BufferUsages
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<BufferUsages> for BufferUsages
impl BitXor<BufferUsages> for BufferUsages
source§impl BitXorAssign<BufferUsages> for BufferUsages
impl BitXorAssign<BufferUsages> for BufferUsages
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
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<'de> Deserialize<'de> for BufferUsages
Available on crate feature replay
only.
impl<'de> Deserialize<'de> for BufferUsages
replay
only.source§fn deserialize<D>(deserializer: D) -> Result<BufferUsages, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<BufferUsages, D::Error>where D: Deserializer<'de>,
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)
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 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
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<BufferUsages> for BufferUsages
impl PartialEq<BufferUsages> 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 Serialize for BufferUsages
Available on crate feature trace
only.
impl Serialize for BufferUsages
trace
only.source§impl Sub<BufferUsages> for BufferUsages
impl Sub<BufferUsages> for BufferUsages
source§impl SubAssign<BufferUsages> for BufferUsages
impl SubAssign<BufferUsages> for BufferUsages
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.