Struct wgpu_types::BufferUsage [−][src]
#[repr(transparent)]pub struct BufferUsage { /* fields omitted */ }
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
impl BufferUsage
[src]
impl BufferUsage
[src]pub const MAP_READ: BufferUsage
[src]
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.
pub const MAP_WRITE: BufferUsage
[src]
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.
pub const COPY_SRC: BufferUsage
[src]
Allow a buffer to be the source buffer for a [CommandEncoder::copy_buffer_to_buffer
] or [CommandEncoder::copy_buffer_to_texture
]
operation.
pub const COPY_DST: BufferUsage
[src]
Allow a buffer to be the destination buffer for a [CommandEncoder::copy_buffer_to_buffer
], [CommandEncoder::copy_texture_to_buffer
],
or [Queue::write_buffer
] operation.
pub const INDEX: BufferUsage
[src]
Allow a buffer to be the index buffer in a draw operation.
pub const VERTEX: BufferUsage
[src]
Allow a buffer to be the vertex buffer in a draw operation.
pub const UNIFORM: BufferUsage
[src]
Allow a buffer to be a BufferBindingType::Uniform
inside a bind group.
pub const STORAGE: BufferUsage
[src]
Allow a buffer to be a BufferBindingType::Storage
inside a bind group.
pub const INDIRECT: BufferUsage
[src]
Allow a buffer to be the indirect buffer in an indirect draw call.
pub const fn empty() -> BufferUsage
[src]
Returns an empty set of flags
pub const fn all() -> BufferUsage
[src]
Returns the set containing all flags.
pub const fn bits(&self) -> u32
[src]
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u32) -> Option<BufferUsage>
[src]
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u32) -> BufferUsage
[src]
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> BufferUsage
[src]
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
[src]
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
[src]
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: BufferUsage) -> bool
[src]
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: BufferUsage) -> bool
[src]
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: BufferUsage)
[src]
Inserts the specified flags in-place.
pub fn remove(&mut self, other: BufferUsage)
[src]
Removes the specified flags in-place.
pub fn toggle(&mut self, other: BufferUsage)
[src]
Toggles the specified flags in-place.
pub fn set(&mut self, other: BufferUsage, value: bool)
[src]
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl BitAnd<BufferUsage> for BufferUsage
[src]
impl BitAnd<BufferUsage> for BufferUsage
[src]type Output = BufferUsage
The resulting type after applying the &
operator.
fn bitand(self, other: BufferUsage) -> BufferUsage
[src]
Returns the intersection between the two sets of flags.
impl BitAndAssign<BufferUsage> for BufferUsage
[src]
impl BitAndAssign<BufferUsage> for BufferUsage
[src]fn bitand_assign(&mut self, other: BufferUsage)
[src]
Disables all flags disabled in the set.
impl BitOr<BufferUsage> for BufferUsage
[src]
impl BitOr<BufferUsage> for BufferUsage
[src]type Output = BufferUsage
The resulting type after applying the |
operator.
fn bitor(self, other: BufferUsage) -> BufferUsage
[src]
Returns the union of the two sets of flags.
impl BitOrAssign<BufferUsage> for BufferUsage
[src]
impl BitOrAssign<BufferUsage> for BufferUsage
[src]fn bitor_assign(&mut self, other: BufferUsage)
[src]
Adds the set of flags.
impl BitXor<BufferUsage> for BufferUsage
[src]
impl BitXor<BufferUsage> for BufferUsage
[src]type Output = BufferUsage
The resulting type after applying the ^
operator.
fn bitxor(self, other: BufferUsage) -> BufferUsage
[src]
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<BufferUsage> for BufferUsage
[src]
impl BitXorAssign<BufferUsage> for BufferUsage
[src]fn bitxor_assign(&mut self, other: BufferUsage)
[src]
Toggles the set of flags.
impl Clone for BufferUsage
[src]
impl Clone for BufferUsage
[src]fn clone(&self) -> BufferUsage
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for BufferUsage
[src]
impl Copy for BufferUsage
[src]impl Eq for BufferUsage
[src]
impl Eq for BufferUsage
[src]impl Extend<BufferUsage> for BufferUsage
[src]
impl Extend<BufferUsage> for BufferUsage
[src]fn extend<T: IntoIterator<Item = BufferUsage>>(&mut self, iterator: T)
[src]
pub fn extend_one(&mut self, item: A)
[src]
pub fn extend_reserve(&mut self, additional: usize)
[src]
impl FromIterator<BufferUsage> for BufferUsage
[src]
impl FromIterator<BufferUsage> for BufferUsage
[src]fn from_iter<T: IntoIterator<Item = BufferUsage>>(iterator: T) -> BufferUsage
[src]
impl Hash for BufferUsage
[src]
impl Hash for BufferUsage
[src]impl Not for BufferUsage
[src]
impl Not for BufferUsage
[src]type Output = BufferUsage
The resulting type after applying the !
operator.
fn not(self) -> BufferUsage
[src]
Returns the complement of this set of flags.
impl Ord for BufferUsage
[src]
impl Ord for BufferUsage
[src]impl PartialEq<BufferUsage> for BufferUsage
[src]
impl PartialEq<BufferUsage> for BufferUsage
[src]fn eq(&self, other: &BufferUsage) -> bool
[src]
fn ne(&self, other: &BufferUsage) -> bool
[src]
impl PartialOrd<BufferUsage> for BufferUsage
[src]
impl PartialOrd<BufferUsage> for BufferUsage
[src]impl StructuralEq for BufferUsage
[src]
impl StructuralEq for BufferUsage
[src]impl StructuralPartialEq for BufferUsage
[src]
impl StructuralPartialEq for BufferUsage
[src]impl Sub<BufferUsage> for BufferUsage
[src]
impl Sub<BufferUsage> for BufferUsage
[src]type Output = BufferUsage
The resulting type after applying the -
operator.
fn sub(self, other: BufferUsage) -> BufferUsage
[src]
Returns the set difference of the two sets of flags.
impl SubAssign<BufferUsage> for BufferUsage
[src]
impl SubAssign<BufferUsage> for BufferUsage
[src]fn sub_assign(&mut self, other: BufferUsage)
[src]
Disables all flags enabled in the set.
Auto Trait Implementations
impl RefUnwindSafe for BufferUsage
impl RefUnwindSafe for BufferUsage
impl Send for BufferUsage
impl Send for BufferUsage
impl Sync for BufferUsage
impl Sync for BufferUsage
impl Unpin for BufferUsage
impl Unpin for BufferUsage
impl UnwindSafe for BufferUsage
impl UnwindSafe for BufferUsage