Struct wgpu::BufferUsages [−][src]
#[repr(transparent)]pub struct BufferUsages { /* 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
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.
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.
Allow a buffer to be the source buffer for a [CommandEncoder::copy_buffer_to_buffer
] or [CommandEncoder::copy_buffer_to_texture
]
operation.
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.
Allow a buffer to be the index buffer in a draw operation.
Allow a buffer to be the vertex buffer in a draw operation.
Allow a buffer to be a BufferBindingType::Uniform
inside a bind group.
Allow a buffer to be a BufferBindingType::Storage
inside a bind group.
Allow a buffer to be the indirect buffer in an indirect draw call.
Returns an empty set of flags.
Returns the set containing all flags.
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
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.
Returns true
if there are flags common to both self
and other
.
Returns true
if all of the flags in other
are contained within self
.
Inserts the specified flags in-place.
Removes the specified flags in-place.
Toggles the specified flags in-place.
Inserts or removes the specified flags depending on the passed value.
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
.
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
.
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
.
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
.
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
.
Trait Implementations
Returns the intersection between the two sets of flags.
type Output = BufferUsages
type Output = BufferUsages
The resulting type after applying the &
operator.
Disables all flags disabled in the set.
Returns the union of the two sets of flags.
type Output = BufferUsages
type Output = BufferUsages
The resulting type after applying the |
operator.
Adds the set of flags.
Returns the left flags, but with all the right flags toggled.
type Output = BufferUsages
type Output = BufferUsages
The resulting type after applying the ^
operator.
Toggles the set of flags.
pub fn deserialize<D>(
deserializer: D
) -> Result<BufferUsages, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub fn deserialize<D>(
deserializer: D
) -> Result<BufferUsages, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
Creates a value from an iterator. Read more
Returns the complement of this set of flags.
type Output = BufferUsages
type Output = BufferUsages
The resulting type after applying the !
operator.
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
Returns the set difference of the two sets of flags.
type Output = BufferUsages
type Output = BufferUsages
The resulting type after applying the -
operator.
Disables all flags enabled in the set.
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
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.