Struct wgpu::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: BufferUsages = Self{ bits: 1 << 0,}
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.
sourcepub const MAP_WRITE: BufferUsages = Self{ bits: 1 << 1,}
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.
sourcepub const COPY_SRC: BufferUsages = Self{ bits: 1 << 2,}
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.
sourcepub const COPY_DST: BufferUsages = Self{ bits: 1 << 3,}
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.
sourcepub const INDEX: BufferUsages = Self{ bits: 1 << 4,}
pub const INDEX: BufferUsages = Self{ bits: 1 << 4,}
Allow a buffer to be the index buffer in a draw operation.
sourcepub const VERTEX: BufferUsages = Self{ bits: 1 << 5,}
pub const VERTEX: BufferUsages = Self{ bits: 1 << 5,}
Allow a buffer to be the vertex buffer in a draw operation.
sourcepub const UNIFORM: BufferUsages = Self{ bits: 1 << 6,}
pub const UNIFORM: BufferUsages = Self{ bits: 1 << 6,}
Allow a buffer to be a BufferBindingType::Uniform
inside a bind group.
sourcepub const STORAGE: BufferUsages = Self{ bits: 1 << 7,}
pub const STORAGE: BufferUsages = Self{ bits: 1 << 7,}
Allow a buffer to be a BufferBindingType::Storage
inside a bind group.
sourcepub const INDIRECT: BufferUsages = Self{ bits: 1 << 8,}
pub const INDIRECT: BufferUsages = Self{ bits: 1 << 8,}
Allow a buffer to be the indirect buffer in an indirect draw call.
sourcepub const fn empty() -> BufferUsages
pub const fn empty() -> BufferUsages
Returns an empty set of flags.
sourcepub const fn all() -> BufferUsages
pub const fn all() -> BufferUsages
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<BufferUsages>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> BufferUsages
pub const fn from_bits_truncate(bits: u32) -> BufferUsages
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> BufferUsages
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.
sourcepub const fn intersects(&self, other: BufferUsages) -> bool
pub const fn intersects(&self, other: BufferUsages) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: BufferUsages) -> bool
pub const fn contains(&self, other: BufferUsages) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: BufferUsages)
pub fn insert(&mut self, other: BufferUsages)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: BufferUsages)
pub fn remove(&mut self, other: BufferUsages)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: BufferUsages)
pub fn toggle(&mut self, other: BufferUsages)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: BufferUsages, value: bool)
pub fn set(&mut self, other: BufferUsages, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: BufferUsages) -> BufferUsages
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
.
sourcepub const fn union(self, other: BufferUsages) -> BufferUsages
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
.
sourcepub const fn difference(self, other: BufferUsages) -> BufferUsages
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
.
sourcepub const fn symmetric_difference(self, other: BufferUsages) -> BufferUsages
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
.
sourcepub const fn complement(self) -> BufferUsages
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
.
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§fn bitand(self, other: BufferUsages) -> BufferUsages
fn bitand(self, other: BufferUsages) -> BufferUsages
Returns the intersection between the two sets of flags.
§type Output = BufferUsages
type Output = BufferUsages
&
operator.source§impl BitAndAssign<BufferUsages> for BufferUsages
impl BitAndAssign<BufferUsages> for BufferUsages
source§fn bitand_assign(&mut self, other: BufferUsages)
fn bitand_assign(&mut self, other: BufferUsages)
Disables all flags disabled in the set.
source§impl BitOr<BufferUsages> for BufferUsages
impl BitOr<BufferUsages> for BufferUsages
source§fn bitor(self, other: BufferUsages) -> BufferUsages
fn bitor(self, other: BufferUsages) -> BufferUsages
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: BufferUsages)
fn bitor_assign(&mut self, other: BufferUsages)
Adds the set of flags.
source§impl BitXor<BufferUsages> for BufferUsages
impl BitXor<BufferUsages> for BufferUsages
source§fn bitxor(self, other: BufferUsages) -> BufferUsages
fn bitxor(self, other: BufferUsages) -> BufferUsages
Returns the left flags, but with all the right flags toggled.
§type Output = BufferUsages
type Output = BufferUsages
^
operator.source§impl BitXorAssign<BufferUsages> for BufferUsages
impl BitXorAssign<BufferUsages> for BufferUsages
source§fn bitxor_assign(&mut self, other: BufferUsages)
fn bitxor_assign(&mut self, other: BufferUsages)
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 Extend<BufferUsages> for BufferUsages
impl Extend<BufferUsages> for BufferUsages
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = BufferUsages>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = BufferUsages>,
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>(iterator: T) -> BufferUsageswhere
T: IntoIterator<Item = BufferUsages>,
fn from_iter<T>(iterator: T) -> BufferUsageswhere T: IntoIterator<Item = BufferUsages>,
source§impl Hash for BufferUsages
impl Hash for BufferUsages
source§impl LowerHex for BufferUsages
impl LowerHex for BufferUsages
source§impl Not for BufferUsages
impl Not for BufferUsages
source§fn not(self) -> BufferUsages
fn not(self) -> BufferUsages
Returns the complement of this set of flags.
§type Output = BufferUsages
type Output = BufferUsages
!
operator.source§impl Octal for BufferUsages
impl Octal for BufferUsages
source§impl Ord for BufferUsages
impl Ord for BufferUsages
source§fn cmp(&self, other: &BufferUsages) -> Ordering
fn cmp(&self, other: &BufferUsages) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
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 PartialOrd<BufferUsages> for BufferUsages
impl PartialOrd<BufferUsages> for BufferUsages
source§fn partial_cmp(&self, other: &BufferUsages) -> Option<Ordering>
fn partial_cmp(&self, other: &BufferUsages) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<BufferUsages> for BufferUsages
impl Sub<BufferUsages> for BufferUsages
source§fn sub(self, other: BufferUsages) -> BufferUsages
fn sub(self, other: BufferUsages) -> BufferUsages
Returns the set difference of the two sets of flags.
§type Output = BufferUsages
type Output = BufferUsages
-
operator.source§impl SubAssign<BufferUsages> for BufferUsages
impl SubAssign<BufferUsages> for BufferUsages
source§fn sub_assign(&mut self, other: BufferUsages)
fn sub_assign(&mut self, other: BufferUsages)
Disables all flags enabled in the set.
source§impl UpperHex for BufferUsages
impl UpperHex for BufferUsages
impl Copy for BufferUsages
impl Eq for BufferUsages
impl StructuralEq for BufferUsages
impl StructuralPartialEq for BufferUsages
Auto Trait Implementations§
impl RefUnwindSafe for BufferUsages
impl Send for BufferUsages
impl Sync for BufferUsages
impl Unpin for BufferUsages
impl UnwindSafe for BufferUsages
Blanket Implementations§
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.