Struct wgpu_types::ColorWrites
source · #[repr(transparent)]pub struct ColorWrites(_);
Expand description
Color write mask. Disabled color channels will not be written to.
Corresponds to WebGPU GPUColorWriteFlags
.
Implementations§
source§impl ColorWrites
impl ColorWrites
source§impl ColorWrites
impl ColorWrites
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 ColorWrites
impl ColorWrites
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 ColorWrites
impl Binary for ColorWrites
source§impl BitAnd<ColorWrites> for ColorWrites
impl BitAnd<ColorWrites> for ColorWrites
source§impl BitAndAssign<ColorWrites> for ColorWrites
impl BitAndAssign<ColorWrites> for ColorWrites
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 ColorWrites
impl BitFlags for ColorWrites
§type IterNames = IterRaw
type IterNames = IterRaw
source§fn from_bits(bits: u32) -> Option<ColorWrites>
fn from_bits(bits: u32) -> Option<ColorWrites>
source§fn from_bits_truncate(bits: u32) -> ColorWrites
fn from_bits_truncate(bits: u32) -> ColorWrites
source§fn from_bits_retain(bits: u32) -> ColorWrites
fn from_bits_retain(bits: u32) -> ColorWrites
source§fn iter_names(&self) -> Self::IterNames
fn iter_names(&self) -> Self::IterNames
source§fn intersects(&self, other: ColorWrites) -> bool
fn intersects(&self, other: ColorWrites) -> bool
true
if there are flags common to both self
and other
.source§fn contains(&self, other: ColorWrites) -> bool
fn contains(&self, other: ColorWrites) -> bool
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: ColorWrites)
fn insert(&mut self, other: ColorWrites)
source§fn remove(&mut self, other: ColorWrites)
fn remove(&mut self, other: ColorWrites)
source§fn toggle(&mut self, other: ColorWrites)
fn toggle(&mut self, other: ColorWrites)
source§fn set(&mut self, other: ColorWrites, value: bool)
fn set(&mut self, other: ColorWrites, value: bool)
source§impl BitOr<ColorWrites> for ColorWrites
impl BitOr<ColorWrites> for ColorWrites
source§fn bitor(self, other: ColorWrites) -> Self
fn bitor(self, other: ColorWrites) -> Self
Returns the union of the two sets of flags.
§type Output = ColorWrites
type Output = ColorWrites
|
operator.source§impl BitOrAssign<ColorWrites> for ColorWrites
impl BitOrAssign<ColorWrites> for ColorWrites
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ColorWrites> for ColorWrites
impl BitXor<ColorWrites> for ColorWrites
source§impl BitXorAssign<ColorWrites> for ColorWrites
impl BitXorAssign<ColorWrites> for ColorWrites
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ColorWrites
impl Clone for ColorWrites
source§fn clone(&self) -> ColorWrites
fn clone(&self) -> ColorWrites
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ColorWrites
impl Debug for ColorWrites
source§impl Default for ColorWrites
impl Default for ColorWrites
source§impl<'de> Deserialize<'de> for ColorWrites
Available on crate feature replay
only.
impl<'de> Deserialize<'de> for ColorWrites
replay
only.source§fn deserialize<D>(deserializer: D) -> Result<ColorWrites, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<ColorWrites, D::Error>where D: Deserializer<'de>,
source§impl Extend<ColorWrites> for ColorWrites
impl Extend<ColorWrites> for ColorWrites
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<ColorWrites> for ColorWrites
impl FromIterator<ColorWrites> for ColorWrites
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 ColorWrites
impl Hash for ColorWrites
source§impl IntoIterator for ColorWrites
impl IntoIterator for ColorWrites
source§impl LowerHex for ColorWrites
impl LowerHex for ColorWrites
source§impl Not for ColorWrites
impl Not for ColorWrites
source§impl Octal for ColorWrites
impl Octal for ColorWrites
source§impl PartialEq<ColorWrites> for ColorWrites
impl PartialEq<ColorWrites> for ColorWrites
source§fn eq(&self, other: &ColorWrites) -> bool
fn eq(&self, other: &ColorWrites) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for ColorWrites
impl PublicFlags for ColorWrites
source§impl Serialize for ColorWrites
Available on crate feature trace
only.
impl Serialize for ColorWrites
trace
only.source§impl Sub<ColorWrites> for ColorWrites
impl Sub<ColorWrites> for ColorWrites
source§impl SubAssign<ColorWrites> for ColorWrites
impl SubAssign<ColorWrites> for ColorWrites
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.