Struct rafx_api::RafxColorFlags
source · pub struct RafxColorFlags { /* private fields */ }
Expand description
Flags for enabling/disabling color channels, used with RafxBlendState
Implementations§
source§impl RafxColorFlags
impl RafxColorFlags
pub const RED: Self = _
pub const GREEN: Self = _
pub const BLUE: Self = _
pub const ALPHA: Self = _
pub const ALL: Self = _
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
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: 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
.
Trait Implementations§
source§impl Binary for RafxColorFlags
impl Binary for RafxColorFlags
source§impl BitAnd for RafxColorFlags
impl BitAnd for RafxColorFlags
source§impl BitAndAssign for RafxColorFlags
impl BitAndAssign for RafxColorFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for RafxColorFlags
impl BitOr for RafxColorFlags
source§fn bitor(self, other: RafxColorFlags) -> Self
fn bitor(self, other: RafxColorFlags) -> Self
Returns the union of the two sets of flags.
§type Output = RafxColorFlags
type Output = RafxColorFlags
|
operator.source§impl BitOrAssign for RafxColorFlags
impl BitOrAssign for RafxColorFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for RafxColorFlags
impl BitXor for RafxColorFlags
source§impl BitXorAssign for RafxColorFlags
impl BitXorAssign for RafxColorFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for RafxColorFlags
impl Clone for RafxColorFlags
source§fn clone(&self) -> RafxColorFlags
fn clone(&self) -> RafxColorFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for RafxColorFlags
impl Debug for RafxColorFlags
source§impl Default for RafxColorFlags
impl Default for RafxColorFlags
source§impl Extend<RafxColorFlags> for RafxColorFlags
impl Extend<RafxColorFlags> for RafxColorFlags
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<RafxColorFlags> for RafxColorFlags
impl FromIterator<RafxColorFlags> for RafxColorFlags
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 RafxColorFlags
impl Hash for RafxColorFlags
source§impl LowerHex for RafxColorFlags
impl LowerHex for RafxColorFlags
source§impl Not for RafxColorFlags
impl Not for RafxColorFlags
source§impl Octal for RafxColorFlags
impl Octal for RafxColorFlags
source§impl Ord for RafxColorFlags
impl Ord for RafxColorFlags
source§fn cmp(&self, other: &RafxColorFlags) -> Ordering
fn cmp(&self, other: &RafxColorFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for RafxColorFlags
impl PartialEq for RafxColorFlags
source§fn eq(&self, other: &RafxColorFlags) -> bool
fn eq(&self, other: &RafxColorFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for RafxColorFlags
impl PartialOrd for RafxColorFlags
source§fn partial_cmp(&self, other: &RafxColorFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &RafxColorFlags) -> 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 for RafxColorFlags
impl Sub for RafxColorFlags
source§impl SubAssign for RafxColorFlags
impl SubAssign for RafxColorFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for RafxColorFlags
impl UpperHex for RafxColorFlags
impl Copy for RafxColorFlags
impl Eq for RafxColorFlags
impl StructuralPartialEq for RafxColorFlags
Auto Trait Implementations§
impl RefUnwindSafe for RafxColorFlags
impl Send for RafxColorFlags
impl Sync for RafxColorFlags
impl Unpin for RafxColorFlags
impl UnwindSafe for RafxColorFlags
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
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.