Struct bgfx_rs::static_lib::DiscardFlags
source · [−]pub struct DiscardFlags { /* private fields */ }
Expand description
Rendering state discard. When state is preserved in submit, rendering states can be discarded on a finer grain.
Implementations
sourceimpl DiscardFlags
impl DiscardFlags
sourcepub const BINDINGS: Self = Self{bits: bgfx_sys::BGFX_DISCARD_BINDINGS as _,}
pub const BINDINGS: Self = Self{bits: bgfx_sys::BGFX_DISCARD_BINDINGS as _,}
Discard texture sampler and buffer bindings.
sourcepub const INDEX_BUFFER: Self = Self{bits: bgfx_sys::BGFX_DISCARD_INDEX_BUFFER as _,}
pub const INDEX_BUFFER: Self = Self{bits: bgfx_sys::BGFX_DISCARD_INDEX_BUFFER as _,}
Discard index buffer.
sourcepub const INSTANCE_DATA: Self = Self{bits: bgfx_sys::BGFX_DISCARD_INSTANCE_DATA as _,}
pub const INSTANCE_DATA: Self = Self{bits: bgfx_sys::BGFX_DISCARD_INSTANCE_DATA as _,}
Discard instance data.
sourcepub const STATE: Self = Self{bits: bgfx_sys::BGFX_DISCARD_STATE as _,}
pub const STATE: Self = Self{bits: bgfx_sys::BGFX_DISCARD_STATE as _,}
Discard state and uniform bindings.
sourcepub const TRANSFORM: Self = Self{bits: bgfx_sys::BGFX_DISCARD_TRANSFORM as _,}
pub const TRANSFORM: Self = Self{bits: bgfx_sys::BGFX_DISCARD_TRANSFORM as _,}
Discard transform.
sourcepub const VERTEX_STREAMS: Self = Self{bits: bgfx_sys::BGFX_DISCARD_VERTEX_STREAMS as _,}
pub const VERTEX_STREAMS: Self = Self{bits: bgfx_sys::BGFX_DISCARD_VERTEX_STREAMS as _,}
Discard vertex streams.
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
sourceimpl Binary for DiscardFlags
impl Binary for DiscardFlags
sourceimpl BitAnd<DiscardFlags> for DiscardFlags
impl BitAnd<DiscardFlags> for DiscardFlags
type Output = DiscardFlags
type Output = DiscardFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<DiscardFlags> for DiscardFlags
impl BitAndAssign<DiscardFlags> for DiscardFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<DiscardFlags> for DiscardFlags
impl BitOr<DiscardFlags> for DiscardFlags
sourcefn bitor(self, other: DiscardFlags) -> Self
fn bitor(self, other: DiscardFlags) -> Self
Returns the union of the two sets of flags.
type Output = DiscardFlags
type Output = DiscardFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<DiscardFlags> for DiscardFlags
impl BitOrAssign<DiscardFlags> for DiscardFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<DiscardFlags> for DiscardFlags
impl BitXor<DiscardFlags> for DiscardFlags
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 = DiscardFlags
type Output = DiscardFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<DiscardFlags> for DiscardFlags
impl BitXorAssign<DiscardFlags> for DiscardFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for DiscardFlags
impl Clone for DiscardFlags
sourcefn clone(&self) -> DiscardFlags
fn clone(&self) -> DiscardFlags
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 DiscardFlags
impl Debug for DiscardFlags
sourceimpl Extend<DiscardFlags> for DiscardFlags
impl Extend<DiscardFlags> for DiscardFlags
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<DiscardFlags> for DiscardFlags
impl FromIterator<DiscardFlags> for DiscardFlags
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 DiscardFlags
impl Hash for DiscardFlags
sourceimpl LowerHex for DiscardFlags
impl LowerHex for DiscardFlags
sourceimpl Not for DiscardFlags
impl Not for DiscardFlags
type Output = DiscardFlags
type Output = DiscardFlags
The resulting type after applying the !
operator.
sourceimpl Octal for DiscardFlags
impl Octal for DiscardFlags
sourceimpl Ord for DiscardFlags
impl Ord for DiscardFlags
sourceimpl PartialEq<DiscardFlags> for DiscardFlags
impl PartialEq<DiscardFlags> for DiscardFlags
sourcefn eq(&self, other: &DiscardFlags) -> bool
fn eq(&self, other: &DiscardFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DiscardFlags) -> bool
fn ne(&self, other: &DiscardFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<DiscardFlags> for DiscardFlags
impl PartialOrd<DiscardFlags> for DiscardFlags
sourcefn partial_cmp(&self, other: &DiscardFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &DiscardFlags) -> 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<DiscardFlags> for DiscardFlags
impl Sub<DiscardFlags> for DiscardFlags
type Output = DiscardFlags
type Output = DiscardFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<DiscardFlags> for DiscardFlags
impl SubAssign<DiscardFlags> for DiscardFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for DiscardFlags
impl UpperHex for DiscardFlags
impl Copy for DiscardFlags
impl Eq for DiscardFlags
impl StructuralEq for DiscardFlags
impl StructuralPartialEq for DiscardFlags
Auto Trait Implementations
impl RefUnwindSafe for DiscardFlags
impl Send for DiscardFlags
impl Sync for DiscardFlags
impl Unpin for DiscardFlags
impl UnwindSafe for DiscardFlags
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