Struct wgpu::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
sourcepub const RED: ColorWrites = Self::from_bits_retain(1 << 0)
pub const RED: ColorWrites = Self::from_bits_retain(1 << 0)
Enable red channel writes
sourcepub const GREEN: ColorWrites = Self::from_bits_retain(1 << 1)
pub const GREEN: ColorWrites = Self::from_bits_retain(1 << 1)
Enable green channel writes
sourcepub const BLUE: ColorWrites = Self::from_bits_retain(1 << 2)
pub const BLUE: ColorWrites = Self::from_bits_retain(1 << 2)
Enable blue channel writes
sourcepub const ALPHA: ColorWrites = Self::from_bits_retain(1 << 3)
pub const ALPHA: ColorWrites = Self::from_bits_retain(1 << 3)
Enable alpha channel writes
sourcepub const COLOR: ColorWrites = Self::from_bits_retain(Self::RED.bits() | Self::GREEN.bits() |
Self::BLUE.bits())
pub const COLOR: ColorWrites = Self::from_bits_retain(Self::RED.bits() | Self::GREEN.bits() | Self::BLUE.bits())
Enable red, green, and blue channel writes
sourcepub const ALL: ColorWrites = Self::from_bits_retain(Self::RED.bits() | Self::GREEN.bits() |
Self::BLUE.bits() | Self::ALPHA.bits())
pub const ALL: ColorWrites = Self::from_bits_retain(Self::RED.bits() | Self::GREEN.bits() | Self::BLUE.bits() | Self::ALPHA.bits())
Enable writes to all channels.
source§impl ColorWrites
impl ColorWrites
sourcepub const fn empty() -> ColorWrites
pub const fn empty() -> ColorWrites
Returns an empty set of flags.
sourcepub const fn all() -> ColorWrites
pub const fn all() -> ColorWrites
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<ColorWrites>
pub const fn from_bits(bits: u32) -> Option<ColorWrites>
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) -> ColorWrites
pub const fn from_bits_truncate(bits: u32) -> ColorWrites
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u32) -> ColorWrites
pub const fn from_bits_retain(bits: u32) -> ColorWrites
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<ColorWrites>
pub fn from_name(name: &str) -> Option<ColorWrites>
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 intersects(&self, other: ColorWrites) -> bool
pub const fn intersects(&self, other: ColorWrites) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: ColorWrites) -> bool
pub const fn contains(&self, other: ColorWrites) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: ColorWrites)
pub fn insert(&mut self, other: ColorWrites)
Inserts the specified flags in-place.
This method is equivalent to union
.
sourcepub fn remove(&mut self, other: ColorWrites)
pub fn remove(&mut self, other: ColorWrites)
Removes the specified flags in-place.
This method is equivalent to difference
.
sourcepub fn toggle(&mut self, other: ColorWrites)
pub fn toggle(&mut self, other: ColorWrites)
Toggles the specified flags in-place.
This method is equivalent to symmetric_difference
.
sourcepub fn set(&mut self, other: ColorWrites, value: bool)
pub fn set(&mut self, other: ColorWrites, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: ColorWrites) -> ColorWrites
pub const fn intersection(self, other: ColorWrites) -> ColorWrites
Returns the intersection between the flags in self
and
other
.
Calculating self
bitwise and (&
) other, including
any bits that don’t correspond to a defined flag.
sourcepub const fn union(self, other: ColorWrites) -> ColorWrites
pub const fn union(self, other: ColorWrites) -> ColorWrites
Returns the union of between the flags in self
and other
.
Calculates self
bitwise or (|
) other
, including
any bits that don’t correspond to a defined flag.
sourcepub const fn difference(self, other: ColorWrites) -> ColorWrites
pub const fn difference(self, other: ColorWrites) -> ColorWrites
Returns the difference between the flags in self
and other
.
Calculates self
bitwise and (&!
) the bitwise negation of other
,
including any bits that don’t correspond to a defined flag.
This method is not equivalent to a & !b
when there are bits set that
don’t correspond to a defined flag. The !
operator will unset any
bits that don’t correspond to a flag, so they’ll always be unset by a &! b
,
but respected by a.difference(b)
.
sourcepub const fn symmetric_difference(self, other: ColorWrites) -> ColorWrites
pub const fn symmetric_difference(self, other: ColorWrites) -> ColorWrites
Returns the symmetric difference between the flags
in self
and other
.
Calculates self
bitwise exclusive or (^
) other
,
including any bits that don’t correspond to a defined flag.
sourcepub const fn complement(self) -> ColorWrites
pub const fn complement(self) -> ColorWrites
Returns the complement of this set of flags.
Calculates the bitwise negation (!
) of self
,
unsetting any bits that don’t correspond to a defined flag.
source§impl ColorWrites
impl ColorWrites
sourcepub const fn iter(&self) -> Iter<ColorWrites>
pub const fn iter(&self) -> Iter<ColorWrites>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<ColorWrites>
pub const fn iter_names(&self) -> IterNames<ColorWrites>
Iterate over enabled flag values with their stringified names.
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§fn bitand(self, other: ColorWrites) -> ColorWrites
fn bitand(self, other: ColorWrites) -> ColorWrites
Returns the intersection between the two sets of flags.
§type Output = ColorWrites
type Output = ColorWrites
&
operator.source§impl BitAndAssign<ColorWrites> for ColorWrites
impl BitAndAssign<ColorWrites> for ColorWrites
source§fn bitand_assign(&mut self, other: ColorWrites)
fn bitand_assign(&mut self, other: ColorWrites)
Disables all flags disabled in the set.
source§impl BitOr<ColorWrites> for ColorWrites
impl BitOr<ColorWrites> for ColorWrites
source§fn bitor(self, other: ColorWrites) -> ColorWrites
fn bitor(self, other: ColorWrites) -> ColorWrites
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: ColorWrites)
fn bitor_assign(&mut self, other: ColorWrites)
Adds the set of flags.
source§impl BitXor<ColorWrites> for ColorWrites
impl BitXor<ColorWrites> for ColorWrites
source§fn bitxor(self, other: ColorWrites) -> ColorWrites
fn bitxor(self, other: ColorWrites) -> ColorWrites
Returns the left flags, but with all the right flags toggled.
§type Output = ColorWrites
type Output = ColorWrites
^
operator.source§impl BitXorAssign<ColorWrites> for ColorWrites
impl BitXorAssign<ColorWrites> for ColorWrites
source§fn bitxor_assign(&mut self, other: ColorWrites)
fn bitxor_assign(&mut self, other: ColorWrites)
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§fn default() -> ColorWrites
fn default() -> 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 as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>( deserializer: D ) -> Result<ColorWrites, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,
source§impl Extend<ColorWrites> for ColorWrites
impl Extend<ColorWrites> for ColorWrites
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ColorWrites>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = ColorWrites>,
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 ColorWrites
impl Flags for ColorWrites
source§const FLAGS: &'static [Flag<ColorWrites>] = &[{ ::bitflags::Flag::new("RED", ColorWrites::RED) },
{ ::bitflags::Flag::new("GREEN", ColorWrites::GREEN) },
{ ::bitflags::Flag::new("BLUE", ColorWrites::BLUE) },
{ ::bitflags::Flag::new("ALPHA", ColorWrites::ALPHA) },
{ ::bitflags::Flag::new("COLOR", ColorWrites::COLOR) },
{ ::bitflags::Flag::new("ALL", ColorWrites::ALL) }]
const FLAGS: &'static [Flag<ColorWrites>] = &[{ ::bitflags::Flag::new("RED", ColorWrites::RED) }, { ::bitflags::Flag::new("GREEN", ColorWrites::GREEN) }, { ::bitflags::Flag::new("BLUE", ColorWrites::BLUE) }, { ::bitflags::Flag::new("ALPHA", ColorWrites::ALPHA) }, { ::bitflags::Flag::new("COLOR", ColorWrites::COLOR) }, { ::bitflags::Flag::new("ALL", ColorWrites::ALL) }]
source§fn from_bits_retain(bits: u32) -> ColorWrites
fn from_bits_retain(bits: u32) -> ColorWrites
source§fn from_bits(bits: Self::Bits) -> Option<Self>
fn from_bits(bits: Self::Bits) -> Option<Self>
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> 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,
true
if there are flags common to both self
and other
.source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where Self: Sized,
source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where Self: Sized,
source§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where Self: Sized,
source§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where Self: Sized,
source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
self
and other
.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
self
and other
.source§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
self
and other
.source§fn complement(self) -> Self
fn complement(self) -> Self
source§impl FromIterator<ColorWrites> for ColorWrites
impl FromIterator<ColorWrites> for ColorWrites
source§fn from_iter<T>(iterator: T) -> ColorWriteswhere
T: IntoIterator<Item = ColorWrites>,
fn from_iter<T>(iterator: T) -> ColorWriteswhere T: IntoIterator<Item = ColorWrites>,
source§impl Hash for ColorWrites
impl Hash for ColorWrites
source§impl IntoIterator for ColorWrites
impl IntoIterator for ColorWrites
§type Item = ColorWrites
type Item = ColorWrites
§type IntoIter = Iter<ColorWrites>
type IntoIter = Iter<ColorWrites>
source§fn into_iter(self) -> <ColorWrites as IntoIterator>::IntoIter
fn into_iter(self) -> <ColorWrites as IntoIterator>::IntoIter
source§impl LowerHex for ColorWrites
impl LowerHex for ColorWrites
source§impl Not for ColorWrites
impl Not for ColorWrites
source§fn not(self) -> ColorWrites
fn not(self) -> ColorWrites
Returns the complement of this set of flags.
§type Output = ColorWrites
type Output = ColorWrites
!
operator.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 Serialize for ColorWrites
Available on crate feature trace
only.
impl Serialize for ColorWrites
trace
only.source§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,
source§impl Sub<ColorWrites> for ColorWrites
impl Sub<ColorWrites> for ColorWrites
source§fn sub(self, other: ColorWrites) -> ColorWrites
fn sub(self, other: ColorWrites) -> ColorWrites
Returns the set difference of the two sets of flags.
§type Output = ColorWrites
type Output = ColorWrites
-
operator.source§impl SubAssign<ColorWrites> for ColorWrites
impl SubAssign<ColorWrites> for ColorWrites
source§fn sub_assign(&mut self, other: ColorWrites)
fn sub_assign(&mut self, other: ColorWrites)
Disables all flags enabled in the set.
source§impl UpperHex for ColorWrites
impl UpperHex for ColorWrites
impl Copy for ColorWrites
impl Eq for ColorWrites
impl StructuralEq for ColorWrites
impl StructuralPartialEq for ColorWrites
Auto Trait Implementations§
impl RefUnwindSafe for ColorWrites
impl Send for ColorWrites
impl Sync for ColorWrites
impl Unpin for ColorWrites
impl UnwindSafe for ColorWrites
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 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.