Struct bgfx_rs::static_lib::StencilTestFlags
source · [−]pub struct StencilTestFlags { /* private fields */ }
Implementations
sourceimpl StencilTestFlags
impl StencilTestFlags
sourcepub const LESS: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_LESS as _,}
pub const LESS: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_LESS as _,}
Enable stencil test, less.
sourcepub const LEQUAL: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_LEQUAL as _,}
pub const LEQUAL: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_LEQUAL as _,}
Enable stencil test, less or equal.
sourcepub const EQUAL: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_EQUAL as _,}
pub const EQUAL: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_EQUAL as _,}
Enable stencil test, equal.
sourcepub const GEQUAL: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_GEQUAL as _,}
pub const GEQUAL: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_GEQUAL as _,}
Enable stencil test, greater or equal.
sourcepub const GREATER: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_GREATER as _,}
pub const GREATER: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_GREATER as _,}
Enable stencil test, greater.
sourcepub const NOTEQUAL: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_NOTEQUAL as _,}
pub const NOTEQUAL: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_NOTEQUAL as _,}
Enable stencil test, not equal.
sourcepub const NEVER: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_NEVER as _,}
pub const NEVER: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_NEVER as _,}
Enable stencil test, never.
sourcepub const ALWAYS: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_ALWAYS as _,}
pub const ALWAYS: Self = Self{bits: bgfx_sys::BGFX_STENCIL_TEST_ALWAYS as _,}
Enable stencil test, always.
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 StencilTestFlags
impl Binary for StencilTestFlags
sourceimpl BitAnd<StencilTestFlags> for StencilTestFlags
impl BitAnd<StencilTestFlags> for StencilTestFlags
type Output = StencilTestFlags
type Output = StencilTestFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<StencilTestFlags> for StencilTestFlags
impl BitAndAssign<StencilTestFlags> for StencilTestFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<StencilTestFlags> for StencilTestFlags
impl BitOr<StencilTestFlags> for StencilTestFlags
sourcefn bitor(self, other: StencilTestFlags) -> Self
fn bitor(self, other: StencilTestFlags) -> Self
Returns the union of the two sets of flags.
type Output = StencilTestFlags
type Output = StencilTestFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<StencilTestFlags> for StencilTestFlags
impl BitOrAssign<StencilTestFlags> for StencilTestFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<StencilTestFlags> for StencilTestFlags
impl BitXor<StencilTestFlags> for StencilTestFlags
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 = StencilTestFlags
type Output = StencilTestFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<StencilTestFlags> for StencilTestFlags
impl BitXorAssign<StencilTestFlags> for StencilTestFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for StencilTestFlags
impl Clone for StencilTestFlags
sourcefn clone(&self) -> StencilTestFlags
fn clone(&self) -> StencilTestFlags
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 StencilTestFlags
impl Debug for StencilTestFlags
sourceimpl Extend<StencilTestFlags> for StencilTestFlags
impl Extend<StencilTestFlags> for StencilTestFlags
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<StencilTestFlags> for StencilTestFlags
impl FromIterator<StencilTestFlags> for StencilTestFlags
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 StencilTestFlags
impl Hash for StencilTestFlags
sourceimpl LowerHex for StencilTestFlags
impl LowerHex for StencilTestFlags
sourceimpl Not for StencilTestFlags
impl Not for StencilTestFlags
type Output = StencilTestFlags
type Output = StencilTestFlags
The resulting type after applying the !
operator.
sourceimpl Octal for StencilTestFlags
impl Octal for StencilTestFlags
sourceimpl Ord for StencilTestFlags
impl Ord for StencilTestFlags
sourceimpl PartialEq<StencilTestFlags> for StencilTestFlags
impl PartialEq<StencilTestFlags> for StencilTestFlags
sourcefn eq(&self, other: &StencilTestFlags) -> bool
fn eq(&self, other: &StencilTestFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StencilTestFlags) -> bool
fn ne(&self, other: &StencilTestFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<StencilTestFlags> for StencilTestFlags
impl PartialOrd<StencilTestFlags> for StencilTestFlags
sourcefn partial_cmp(&self, other: &StencilTestFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StencilTestFlags) -> 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<StencilTestFlags> for StencilTestFlags
impl Sub<StencilTestFlags> for StencilTestFlags
type Output = StencilTestFlags
type Output = StencilTestFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<StencilTestFlags> for StencilTestFlags
impl SubAssign<StencilTestFlags> for StencilTestFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for StencilTestFlags
impl UpperHex for StencilTestFlags
impl Copy for StencilTestFlags
impl Eq for StencilTestFlags
impl StructuralEq for StencilTestFlags
impl StructuralPartialEq for StencilTestFlags
Auto Trait Implementations
impl RefUnwindSafe for StencilTestFlags
impl Send for StencilTestFlags
impl Sync for StencilTestFlags
impl Unpin for StencilTestFlags
impl UnwindSafe for StencilTestFlags
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