Struct wgpu_types::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: 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 bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl TextureUsages
impl TextureUsages
sourcepub const fn iter(&self) -> Iter<TextureUsages>
pub const fn iter(&self) -> Iter<TextureUsages>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<TextureUsages>
pub const fn iter_names(&self) -> IterNames<TextureUsages>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
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 for TextureUsages
impl BitAnd for TextureUsages
source§impl BitAndAssign for TextureUsages
impl BitAndAssign for TextureUsages
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for TextureUsages
impl BitOr for TextureUsages
source§fn bitor(self, other: TextureUsages) -> Self
fn bitor(self, other: TextureUsages) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = TextureUsages
type Output = TextureUsages
|
operator.source§impl BitOrAssign for TextureUsages
impl BitOrAssign for TextureUsages
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for TextureUsages
impl BitXor for TextureUsages
source§impl BitXorAssign for TextureUsages
impl BitXorAssign for TextureUsages
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
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: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
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 Flags for TextureUsages
impl Flags for TextureUsages
source§const FLAGS: &'static [Flag<TextureUsages>] = _
const FLAGS: &'static [Flag<TextureUsages>] = _
source§fn from_bits_retain(bits: u32) -> TextureUsages
fn from_bits_retain(bits: u32) -> TextureUsages
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.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
The bitwise or (|
) of the bits in each flags value.
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 for TextureUsages
impl PartialEq 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 Sub for TextureUsages
impl Sub for TextureUsages
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = TextureUsages
type Output = TextureUsages
-
operator.source§impl SubAssign for TextureUsages
impl SubAssign for TextureUsages
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.