Struct wgpu::ColorWrites
source · pub struct ColorWrites { /* private fields */ }
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{ bits: 1 << 0,}
pub const RED: ColorWrites = Self{ bits: 1 << 0,}
Enable red channel writes
sourcepub const GREEN: ColorWrites = Self{ bits: 1 << 1,}
pub const GREEN: ColorWrites = Self{ bits: 1 << 1,}
Enable green channel writes
sourcepub const BLUE: ColorWrites = Self{ bits: 1 << 2,}
pub const BLUE: ColorWrites = Self{ bits: 1 << 2,}
Enable blue channel writes
sourcepub const ALPHA: ColorWrites = Self{ bits: 1 << 3,}
pub const ALPHA: ColorWrites = Self{ bits: 1 << 3,}
Enable alpha channel writes
sourcepub const COLOR: ColorWrites = Self{ bits: Self::RED.bits | Self::GREEN.bits | Self::BLUE.bits,}
pub const COLOR: ColorWrites = Self{ bits: Self::RED.bits | Self::GREEN.bits | Self::BLUE.bits,}
Enable red, green, and blue channel writes
sourcepub const ALL: ColorWrites = Self{
bits:
Self::RED.bits | Self::GREEN.bits | Self::BLUE.bits |
Self::ALPHA.bits,}
pub const ALL: ColorWrites = Self{ bits: Self::RED.bits | Self::GREEN.bits | Self::BLUE.bits | Self::ALPHA.bits,}
Enable writes to all channels.
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 unsafe fn from_bits_unchecked(bits: u32) -> ColorWrites
pub const unsafe fn from_bits_unchecked(bits: u32) -> ColorWrites
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
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.
sourcepub fn remove(&mut self, other: ColorWrites)
pub fn remove(&mut self, other: ColorWrites)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: ColorWrites)
pub fn toggle(&mut self, other: ColorWrites)
Toggles the specified flags in-place.
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
.
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: ColorWrites) -> ColorWrites
pub const fn union(self, other: ColorWrites) -> ColorWrites
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: ColorWrites) -> ColorWrites
pub const fn difference(self, other: ColorWrites) -> ColorWrites
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: ColorWrites) -> ColorWrites
pub const fn symmetric_difference(self, other: ColorWrites) -> ColorWrites
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) -> ColorWrites
pub const fn complement(self) -> ColorWrites
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§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 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 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 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 Ord for ColorWrites
impl Ord for ColorWrites
source§fn cmp(&self, other: &ColorWrites) -> Ordering
fn cmp(&self, other: &ColorWrites) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
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 PartialOrd<ColorWrites> for ColorWrites
impl PartialOrd<ColorWrites> for ColorWrites
source§fn partial_cmp(&self, other: &ColorWrites) -> Option<Ordering>
fn partial_cmp(&self, other: &ColorWrites) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§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<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.