Struct wgpu_hal::FormatAspects
source · pub struct FormatAspects(/* private fields */);
Expand description
Texture format capability flags.
Implementations§
source§impl FormatAspects
impl FormatAspects
source§impl FormatAspects
impl FormatAspects
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> 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 FormatAspects
impl FormatAspects
sourcepub const fn iter(&self) -> Iter<FormatAspects>
pub const fn iter(&self) -> Iter<FormatAspects>
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<FormatAspects>
pub const fn iter_names(&self) -> IterNames<FormatAspects>
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 FormatAspects
impl FormatAspects
pub fn new(format: TextureFormat, aspect: TextureAspect) -> Self
pub fn map(&self) -> TextureAspect
Trait Implementations§
source§impl Binary for FormatAspects
impl Binary for FormatAspects
source§impl BitAnd for FormatAspects
impl BitAnd for FormatAspects
source§impl BitAndAssign for FormatAspects
impl BitAndAssign for FormatAspects
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 FormatAspects
impl BitOr for FormatAspects
source§fn bitor(self, other: FormatAspects) -> Self
fn bitor(self, other: FormatAspects) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = FormatAspects
type Output = FormatAspects
|
operator.source§impl BitOrAssign for FormatAspects
impl BitOrAssign for FormatAspects
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 FormatAspects
impl BitXor for FormatAspects
source§impl BitXorAssign for FormatAspects
impl BitXorAssign for FormatAspects
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 FormatAspects
impl Clone for FormatAspects
source§fn clone(&self) -> FormatAspects
fn clone(&self) -> FormatAspects
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for FormatAspects
impl Debug for FormatAspects
source§impl Extend<FormatAspects> for FormatAspects
impl Extend<FormatAspects> for FormatAspects
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 FormatAspects
impl Flags for FormatAspects
source§const FLAGS: &'static [Flag<FormatAspects>] = _
const FLAGS: &'static [Flag<FormatAspects>] = _
source§fn from_bits_retain(bits: u8) -> FormatAspects
fn from_bits_retain(bits: u8) -> FormatAspects
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 From<TextureFormat> for FormatAspects
impl From<TextureFormat> for FormatAspects
source§fn from(format: TextureFormat) -> Self
fn from(format: TextureFormat) -> Self
source§impl FromIterator<FormatAspects> for FormatAspects
impl FromIterator<FormatAspects> for FormatAspects
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 FormatAspects
impl Hash for FormatAspects
source§impl IntoIterator for FormatAspects
impl IntoIterator for FormatAspects
source§impl LowerHex for FormatAspects
impl LowerHex for FormatAspects
source§impl Not for FormatAspects
impl Not for FormatAspects
source§impl Octal for FormatAspects
impl Octal for FormatAspects
source§impl PartialEq for FormatAspects
impl PartialEq for FormatAspects
source§fn eq(&self, other: &FormatAspects) -> bool
fn eq(&self, other: &FormatAspects) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for FormatAspects
impl PublicFlags for FormatAspects
source§impl Sub for FormatAspects
impl Sub for FormatAspects
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 = FormatAspects
type Output = FormatAspects
-
operator.source§impl SubAssign for FormatAspects
impl SubAssign for FormatAspects
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.
source§impl UpperHex for FormatAspects
impl UpperHex for FormatAspects
impl Copy for FormatAspects
impl Eq for FormatAspects
impl StructuralPartialEq for FormatAspects
Auto Trait Implementations§
impl Freeze for FormatAspects
impl RefUnwindSafe for FormatAspects
impl Send for FormatAspects
impl Sync for FormatAspects
impl Unpin for FormatAspects
impl UnwindSafe for FormatAspects
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.