Struct bgfx_rs::static_lib::ClearFlags
source · [−]pub struct ClearFlags { /* private fields */ }
Implementations
sourceimpl ClearFlags
impl ClearFlags
sourcepub const DISCARD_COLOR_0: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_0 as _,}
pub const DISCARD_COLOR_0: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_0 as _,}
Discard frame buffer attachment 0.
sourcepub const DISCARD_COLOR_1: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_1 as _,}
pub const DISCARD_COLOR_1: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_1 as _,}
Discard frame buffer attachment 1.
sourcepub const DISCARD_COLOR_2: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_2 as _,}
pub const DISCARD_COLOR_2: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_2 as _,}
Discard frame buffer attachment 2.
sourcepub const DISCARD_COLOR_3: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_3 as _,}
pub const DISCARD_COLOR_3: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_3 as _,}
Discard frame buffer attachment 3.
sourcepub const DISCARD_COLOR_4: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_4 as _,}
pub const DISCARD_COLOR_4: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_4 as _,}
Discard frame buffer attachment 4.
sourcepub const DISCARD_COLOR_5: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_5 as _,}
pub const DISCARD_COLOR_5: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_5 as _,}
Discard frame buffer attachment 5.
sourcepub const DISCARD_COLOR_6: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_6 as _,}
pub const DISCARD_COLOR_6: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_6 as _,}
Discard frame buffer attachment 6.
sourcepub const DISCARD_COLOR_7: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_7 as _,}
pub const DISCARD_COLOR_7: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_7 as _,}
Discard frame buffer attachment 7.
sourcepub const DISCARD_DEPTH: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_DEPTH as _,}
pub const DISCARD_DEPTH: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_DEPTH as _,}
Discard frame buffer depth attachment.
sourcepub const DISCARD_STENCIL: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_STENCIL as _,}
pub const DISCARD_STENCIL: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_STENCIL as _,}
Discard frame buffer stencil attachment.
pub const DISCARD_COLOR_MASK: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_COLOR_MASK as _,}
pub const DISCARD_MASK: Self = Self{bits: bgfx_sys::BGFX_CLEAR_DISCARD_MASK as _,}
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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
sourceimpl Binary for ClearFlags
impl Binary for ClearFlags
sourceimpl BitAnd<ClearFlags> for ClearFlags
impl BitAnd<ClearFlags> for ClearFlags
type Output = ClearFlags
type Output = ClearFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<ClearFlags> for ClearFlags
impl BitAndAssign<ClearFlags> for ClearFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ClearFlags> for ClearFlags
impl BitOr<ClearFlags> for ClearFlags
sourcefn 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
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ClearFlags> for ClearFlags
impl BitOrAssign<ClearFlags> for ClearFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ClearFlags> for ClearFlags
impl BitXor<ClearFlags> for ClearFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = ClearFlags
type Output = ClearFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<ClearFlags> for ClearFlags
impl BitXorAssign<ClearFlags> for ClearFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ClearFlags
impl Clone for ClearFlags
sourcefn clone(&self) -> ClearFlags
fn clone(&self) -> ClearFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ClearFlags
impl Debug for ClearFlags
sourceimpl Extend<ClearFlags> for ClearFlags
impl Extend<ClearFlags> for ClearFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<ClearFlags> for ClearFlags
impl FromIterator<ClearFlags> for ClearFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for ClearFlags
impl Hash for ClearFlags
sourceimpl LowerHex for ClearFlags
impl LowerHex for ClearFlags
sourceimpl Not for ClearFlags
impl Not for ClearFlags
type Output = ClearFlags
type Output = ClearFlags
The resulting type after applying the !
operator.
sourceimpl Octal for ClearFlags
impl Octal for ClearFlags
sourceimpl Ord for ClearFlags
impl Ord for ClearFlags
sourceimpl PartialEq<ClearFlags> for ClearFlags
impl PartialEq<ClearFlags> for ClearFlags
sourcefn eq(&self, other: &ClearFlags) -> bool
fn eq(&self, other: &ClearFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ClearFlags) -> bool
fn ne(&self, other: &ClearFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ClearFlags> for ClearFlags
impl PartialOrd<ClearFlags> for ClearFlags
sourcefn partial_cmp(&self, other: &ClearFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ClearFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<ClearFlags> for ClearFlags
impl Sub<ClearFlags> for ClearFlags
type Output = ClearFlags
type Output = ClearFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<ClearFlags> for ClearFlags
impl SubAssign<ClearFlags> for ClearFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for ClearFlags
impl UpperHex for ClearFlags
impl Copy for ClearFlags
impl Eq for ClearFlags
impl StructuralEq for ClearFlags
impl StructuralPartialEq for ClearFlags
Auto Trait Implementations
impl RefUnwindSafe for ClearFlags
impl Send for ClearFlags
impl Sync for ClearFlags
impl Unpin for ClearFlags
impl UnwindSafe for ClearFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more