Struct bgfx_rs::static_lib::StencilFlags
source · [−]pub struct StencilFlags { /* private fields */ }
Implementations
sourceimpl StencilFlags
impl StencilFlags
pub const NONE: Self = Self{bits: bgfx_sys::BGFX_STENCIL_NONE as _,}
pub const MASK: Self = Self{bits: bgfx_sys::BGFX_STENCIL_MASK as _,}
pub const DEFAULT: Self = Self{bits: bgfx_sys::BGFX_STENCIL_DEFAULT as _,}
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> 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 StencilFlags
impl Binary for StencilFlags
sourceimpl BitAnd<StencilFlags> for StencilFlags
impl BitAnd<StencilFlags> for StencilFlags
type Output = StencilFlags
type Output = StencilFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<StencilFlags> for StencilFlags
impl BitAndAssign<StencilFlags> for StencilFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<StencilFlags> for StencilFlags
impl BitOr<StencilFlags> for StencilFlags
sourcefn bitor(self, other: StencilFlags) -> Self
fn bitor(self, other: StencilFlags) -> Self
Returns the union of the two sets of flags.
type Output = StencilFlags
type Output = StencilFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<StencilFlags> for StencilFlags
impl BitOrAssign<StencilFlags> for StencilFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<StencilFlags> for StencilFlags
impl BitXor<StencilFlags> for StencilFlags
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 = StencilFlags
type Output = StencilFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<StencilFlags> for StencilFlags
impl BitXorAssign<StencilFlags> for StencilFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for StencilFlags
impl Clone for StencilFlags
sourcefn clone(&self) -> StencilFlags
fn clone(&self) -> StencilFlags
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 StencilFlags
impl Debug for StencilFlags
sourceimpl Extend<StencilFlags> for StencilFlags
impl Extend<StencilFlags> for StencilFlags
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<StencilFlags> for StencilFlags
impl FromIterator<StencilFlags> for StencilFlags
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 StencilFlags
impl Hash for StencilFlags
sourceimpl LowerHex for StencilFlags
impl LowerHex for StencilFlags
sourceimpl Not for StencilFlags
impl Not for StencilFlags
type Output = StencilFlags
type Output = StencilFlags
The resulting type after applying the !
operator.
sourceimpl Octal for StencilFlags
impl Octal for StencilFlags
sourceimpl Ord for StencilFlags
impl Ord for StencilFlags
sourceimpl PartialEq<StencilFlags> for StencilFlags
impl PartialEq<StencilFlags> for StencilFlags
sourcefn eq(&self, other: &StencilFlags) -> bool
fn eq(&self, other: &StencilFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StencilFlags) -> bool
fn ne(&self, other: &StencilFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<StencilFlags> for StencilFlags
impl PartialOrd<StencilFlags> for StencilFlags
sourcefn partial_cmp(&self, other: &StencilFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StencilFlags) -> 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<StencilFlags> for StencilFlags
impl Sub<StencilFlags> for StencilFlags
type Output = StencilFlags
type Output = StencilFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<StencilFlags> for StencilFlags
impl SubAssign<StencilFlags> for StencilFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for StencilFlags
impl UpperHex for StencilFlags
impl Copy for StencilFlags
impl Eq for StencilFlags
impl StructuralEq for StencilFlags
impl StructuralPartialEq for StencilFlags
Auto Trait Implementations
impl RefUnwindSafe for StencilFlags
impl Send for StencilFlags
impl Sync for StencilFlags
impl Unpin for StencilFlags
impl UnwindSafe for StencilFlags
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