Struct citro3d::render::ClearFlags
source · pub struct ClearFlags { /* private fields */ }
Expand description
Indicate whether color, depth buffer, or both values should be cleared.
Implementations§
source§impl ClearFlags
impl ClearFlags
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 ClearFlags
impl Binary for ClearFlags
source§impl BitAnd for ClearFlags
impl BitAnd for ClearFlags
source§impl BitAndAssign for ClearFlags
impl BitAndAssign for ClearFlags
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 ClearFlags
impl BitOr for ClearFlags
source§fn bitor(self, other: ClearFlags) -> Self
fn bitor(self, other: ClearFlags) -> Self
Returns the union of the two sets of flags.
§type Output = ClearFlags
type Output = ClearFlags
|
operator.source§impl BitOrAssign for ClearFlags
impl BitOrAssign for ClearFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for ClearFlags
impl BitXor for ClearFlags
source§impl BitXorAssign for ClearFlags
impl BitXorAssign for ClearFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ClearFlags
impl Clone for ClearFlags
source§fn clone(&self) -> ClearFlags
fn clone(&self) -> ClearFlags
1.0.0§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ClearFlags
impl Debug for ClearFlags
source§impl Extend<ClearFlags> for ClearFlags
impl Extend<ClearFlags> for ClearFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<ClearFlags> for ClearFlags
impl FromIterator<ClearFlags> for ClearFlags
source§impl Hash for ClearFlags
impl Hash for ClearFlags
source§impl LowerHex for ClearFlags
impl LowerHex for ClearFlags
source§impl Not for ClearFlags
impl Not for ClearFlags
source§impl Octal for ClearFlags
impl Octal for ClearFlags
source§impl Ord for ClearFlags
impl Ord for ClearFlags
source§impl PartialEq for ClearFlags
impl PartialEq for ClearFlags
source§impl PartialOrd for ClearFlags
impl PartialOrd for ClearFlags
source§impl Sub for ClearFlags
impl Sub for ClearFlags
source§impl SubAssign for ClearFlags
impl SubAssign for ClearFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.