Struct wgpu_types::TextureUsages
source · #[repr(transparent)]pub struct TextureUsages(_);
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: Self = _
pub const COPY_SRC: Self = _
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: Self = _
pub const COPY_DST: Self = _
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: Self = _
pub const TEXTURE_BINDING: Self = _
Allows a texture to be a BindingType::Texture
in a bind group.
sourcepub const STORAGE_BINDING: Self = _
pub const STORAGE_BINDING: Self = _
Allows a texture to be a BindingType::StorageTexture
in a bind group.
sourcepub const RENDER_ATTACHMENT: Self = _
pub const RENDER_ATTACHMENT: Self = _
Allows a texture to be an output attachment of a render pass.
source§impl TextureUsages
impl TextureUsages
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 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§impl BitAndAssign<TextureUsages> for TextureUsages
impl BitAndAssign<TextureUsages> for TextureUsages
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 TextureUsages
impl BitFlags for TextureUsages
§type IterNames = IterRaw
type IterNames = IterRaw
source§fn from_bits(bits: u32) -> Option<TextureUsages>
fn from_bits(bits: u32) -> Option<TextureUsages>
source§fn from_bits_truncate(bits: u32) -> TextureUsages
fn from_bits_truncate(bits: u32) -> TextureUsages
source§fn from_bits_retain(bits: u32) -> TextureUsages
fn from_bits_retain(bits: u32) -> TextureUsages
source§fn iter_names(&self) -> Self::IterNames
fn iter_names(&self) -> Self::IterNames
source§fn intersects(&self, other: TextureUsages) -> bool
fn intersects(&self, other: TextureUsages) -> bool
true
if there are flags common to both self
and other
.source§fn contains(&self, other: TextureUsages) -> bool
fn contains(&self, other: TextureUsages) -> bool
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: TextureUsages)
fn insert(&mut self, other: TextureUsages)
source§fn remove(&mut self, other: TextureUsages)
fn remove(&mut self, other: TextureUsages)
source§fn toggle(&mut self, other: TextureUsages)
fn toggle(&mut self, other: TextureUsages)
source§fn set(&mut self, other: TextureUsages, value: bool)
fn set(&mut self, other: TextureUsages, value: bool)
source§impl BitOr<TextureUsages> for TextureUsages
impl BitOr<TextureUsages> for TextureUsages
source§fn bitor(self, other: TextureUsages) -> Self
fn bitor(self, other: TextureUsages) -> Self
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: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<TextureUsages> for TextureUsages
impl BitXor<TextureUsages> for TextureUsages
source§impl BitXorAssign<TextureUsages> for TextureUsages
impl BitXorAssign<TextureUsages> for TextureUsages
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
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<'de> Deserialize<'de> for TextureUsages
Available on crate feature replay
only.
impl<'de> Deserialize<'de> for TextureUsages
replay
only.source§fn deserialize<D>(deserializer: D) -> Result<TextureUsages, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<TextureUsages, D::Error>where D: Deserializer<'de>,
source§impl Extend<TextureUsages> for TextureUsages
impl Extend<TextureUsages> for TextureUsages
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<TextureUsages> for TextureUsages
impl FromIterator<TextureUsages> for TextureUsages
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 TextureUsages
impl Hash for TextureUsages
source§impl IntoIterator for TextureUsages
impl IntoIterator for TextureUsages
source§impl LowerHex for TextureUsages
impl LowerHex for TextureUsages
source§impl Not for TextureUsages
impl Not for TextureUsages
source§impl Octal for TextureUsages
impl Octal for TextureUsages
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 PublicFlags for TextureUsages
impl PublicFlags for TextureUsages
source§impl Serialize for TextureUsages
Available on crate feature trace
only.
impl Serialize for TextureUsages
trace
only.source§impl Sub<TextureUsages> for TextureUsages
impl Sub<TextureUsages> for TextureUsages
source§impl SubAssign<TextureUsages> for TextureUsages
impl SubAssign<TextureUsages> for TextureUsages
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.