Struct wgpu::TextureUsages
source · pub struct TextureUsages { /* private fields */ }
Expand description
Different ways that you can use a texture.
The usages determine what kind of memory the texture is allocated from and what actions the texture can partake in.
Corresponds to WebGPU GPUTextureUsageFlags
.
Implementations§
source§impl TextureUsages
impl TextureUsages
sourcepub const COPY_SRC: TextureUsages = Self{ bits: 1 << 0,}
pub const COPY_SRC: TextureUsages = Self{ bits: 1 << 0,}
Allows a texture to be the source in a [CommandEncoder::copy_texture_to_buffer
] or
[CommandEncoder::copy_texture_to_texture
] operation.
sourcepub const COPY_DST: TextureUsages = Self{ bits: 1 << 1,}
pub const COPY_DST: TextureUsages = Self{ bits: 1 << 1,}
Allows a texture to be the destination in a [CommandEncoder::copy_buffer_to_texture
],
[CommandEncoder::copy_texture_to_texture
], or [Queue::write_texture
] operation.
sourcepub const TEXTURE_BINDING: TextureUsages = Self{ bits: 1 << 2,}
pub const TEXTURE_BINDING: TextureUsages = Self{ bits: 1 << 2,}
Allows a texture to be a BindingType::Texture
in a bind group.
sourcepub const STORAGE_BINDING: TextureUsages = Self{ bits: 1 << 3,}
pub const STORAGE_BINDING: TextureUsages = Self{ bits: 1 << 3,}
Allows a texture to be a BindingType::StorageTexture
in a bind group.
sourcepub const RENDER_ATTACHMENT: TextureUsages = Self{ bits: 1 << 4,}
pub const RENDER_ATTACHMENT: TextureUsages = Self{ bits: 1 << 4,}
Allows a texture to be an output attachment of a render pass.
sourcepub const fn empty() -> TextureUsages
pub const fn empty() -> TextureUsages
Returns an empty set of flags.
sourcepub const fn all() -> TextureUsages
pub const fn all() -> TextureUsages
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<TextureUsages>
pub const fn from_bits(bits: u32) -> Option<TextureUsages>
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) -> TextureUsages
pub const fn from_bits_truncate(bits: u32) -> TextureUsages
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> TextureUsages
pub const unsafe fn from_bits_unchecked(bits: u32) -> TextureUsages
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: TextureUsages) -> bool
pub const fn intersects(&self, other: TextureUsages) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: TextureUsages) -> bool
pub const fn contains(&self, other: TextureUsages) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: TextureUsages)
pub fn insert(&mut self, other: TextureUsages)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: TextureUsages)
pub fn remove(&mut self, other: TextureUsages)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: TextureUsages)
pub fn toggle(&mut self, other: TextureUsages)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: TextureUsages, value: bool)
pub fn set(&mut self, other: TextureUsages, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: TextureUsages) -> TextureUsages
pub const fn intersection(self, other: TextureUsages) -> TextureUsages
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: TextureUsages) -> TextureUsages
pub const fn union(self, other: TextureUsages) -> TextureUsages
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: TextureUsages) -> TextureUsages
pub const fn difference(self, other: TextureUsages) -> TextureUsages
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: TextureUsages) -> TextureUsages
pub const fn symmetric_difference(self, other: TextureUsages) -> TextureUsages
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) -> TextureUsages
pub const fn complement(self) -> TextureUsages
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 TextureUsages
impl TextureUsages
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 TextureUsages
impl Binary for TextureUsages
source§impl BitAnd<TextureUsages> for TextureUsages
impl BitAnd<TextureUsages> for TextureUsages
source§fn bitand(self, other: TextureUsages) -> TextureUsages
fn bitand(self, other: TextureUsages) -> TextureUsages
Returns the intersection between the two sets of flags.
§type Output = TextureUsages
type Output = TextureUsages
&
operator.source§impl BitAndAssign<TextureUsages> for TextureUsages
impl BitAndAssign<TextureUsages> for TextureUsages
source§fn bitand_assign(&mut self, other: TextureUsages)
fn bitand_assign(&mut self, other: TextureUsages)
Disables all flags disabled in the set.
source§impl BitOr<TextureUsages> for TextureUsages
impl BitOr<TextureUsages> for TextureUsages
source§fn bitor(self, other: TextureUsages) -> TextureUsages
fn bitor(self, other: TextureUsages) -> TextureUsages
Returns the union of the two sets of flags.
§type Output = TextureUsages
type Output = TextureUsages
|
operator.source§impl BitOrAssign<TextureUsages> for TextureUsages
impl BitOrAssign<TextureUsages> for TextureUsages
source§fn bitor_assign(&mut self, other: TextureUsages)
fn bitor_assign(&mut self, other: TextureUsages)
Adds the set of flags.
source§impl BitXor<TextureUsages> for TextureUsages
impl BitXor<TextureUsages> for TextureUsages
source§fn bitxor(self, other: TextureUsages) -> TextureUsages
fn bitxor(self, other: TextureUsages) -> TextureUsages
Returns the left flags, but with all the right flags toggled.
§type Output = TextureUsages
type Output = TextureUsages
^
operator.source§impl BitXorAssign<TextureUsages> for TextureUsages
impl BitXorAssign<TextureUsages> for TextureUsages
source§fn bitxor_assign(&mut self, other: TextureUsages)
fn bitxor_assign(&mut self, other: TextureUsages)
Toggles the set of flags.
source§impl Clone for TextureUsages
impl Clone for TextureUsages
source§fn clone(&self) -> TextureUsages
fn clone(&self) -> TextureUsages
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TextureUsages
impl Debug for TextureUsages
source§impl Extend<TextureUsages> for TextureUsages
impl Extend<TextureUsages> for TextureUsages
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = TextureUsages>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = TextureUsages>,
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<TextureUsages> for TextureUsages
impl FromIterator<TextureUsages> for TextureUsages
source§fn from_iter<T>(iterator: T) -> TextureUsageswhere
T: IntoIterator<Item = TextureUsages>,
fn from_iter<T>(iterator: T) -> TextureUsageswhere T: IntoIterator<Item = TextureUsages>,
source§impl Hash for TextureUsages
impl Hash for TextureUsages
source§impl LowerHex for TextureUsages
impl LowerHex for TextureUsages
source§impl Not for TextureUsages
impl Not for TextureUsages
source§fn not(self) -> TextureUsages
fn not(self) -> TextureUsages
Returns the complement of this set of flags.
§type Output = TextureUsages
type Output = TextureUsages
!
operator.source§impl Octal for TextureUsages
impl Octal for TextureUsages
source§impl Ord for TextureUsages
impl Ord for TextureUsages
source§fn cmp(&self, other: &TextureUsages) -> Ordering
fn cmp(&self, other: &TextureUsages) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<TextureUsages> for TextureUsages
impl PartialEq<TextureUsages> for TextureUsages
source§fn eq(&self, other: &TextureUsages) -> bool
fn eq(&self, other: &TextureUsages) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<TextureUsages> for TextureUsages
impl PartialOrd<TextureUsages> for TextureUsages
source§fn partial_cmp(&self, other: &TextureUsages) -> Option<Ordering>
fn partial_cmp(&self, other: &TextureUsages) -> 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<TextureUsages> for TextureUsages
impl Sub<TextureUsages> for TextureUsages
source§fn sub(self, other: TextureUsages) -> TextureUsages
fn sub(self, other: TextureUsages) -> TextureUsages
Returns the set difference of the two sets of flags.
§type Output = TextureUsages
type Output = TextureUsages
-
operator.source§impl SubAssign<TextureUsages> for TextureUsages
impl SubAssign<TextureUsages> for TextureUsages
source§fn sub_assign(&mut self, other: TextureUsages)
fn sub_assign(&mut self, other: TextureUsages)
Disables all flags enabled in the set.
source§impl UpperHex for TextureUsages
impl UpperHex for TextureUsages
impl Copy for TextureUsages
impl Eq for TextureUsages
impl StructuralEq for TextureUsages
impl StructuralPartialEq for TextureUsages
Auto Trait Implementations§
impl RefUnwindSafe for TextureUsages
impl Send for TextureUsages
impl Sync for TextureUsages
impl Unpin for TextureUsages
impl UnwindSafe for TextureUsages
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.