Struct bgfx_rs::static_lib::StateBlendFlags
source · pub struct StateBlendFlags { /* private fields */ }
Expand description
Use state_blend_func or state_blend_func_separate helper macros.
Implementations§
source§impl StateBlendFlags
impl StateBlendFlags
sourcepub const INV_SRC_COLOR: Self = _
pub const INV_SRC_COLOR: Self = _
1-Rs, 1-Gs, 1-Bs, 1-As
sourcepub const INV_SRC_ALPHA: Self = _
pub const INV_SRC_ALPHA: Self = _
1-As, 1-As, 1-As, 1-As
sourcepub const INV_DST_ALPHA: Self = _
pub const INV_DST_ALPHA: Self = _
1-Ad, 1-Ad, 1-Ad ,1-Ad
sourcepub const INV_DST_COLOR: Self = _
pub const INV_DST_COLOR: Self = _
1-Rd, 1-Gd, 1-Bd, 1-Ad
sourcepub const SRC_ALPHA_SAT: Self = _
pub const SRC_ALPHA_SAT: Self = _
f, f, f, 1; f = min(As, 1-Ad)
sourcepub const INV_FACTOR: Self = _
pub const INV_FACTOR: Self = _
1-Blend factor
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> 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: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
pub const unsafe fn from_bits_unchecked(bits: u64) -> 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 StateBlendFlags
impl Binary for StateBlendFlags
source§impl BitAnd for StateBlendFlags
impl BitAnd for StateBlendFlags
source§impl BitAndAssign for StateBlendFlags
impl BitAndAssign for StateBlendFlags
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 StateBlendFlags
impl BitOr for StateBlendFlags
source§fn bitor(self, other: StateBlendFlags) -> Self
fn bitor(self, other: StateBlendFlags) -> Self
Returns the union of the two sets of flags.
§type Output = StateBlendFlags
type Output = StateBlendFlags
|
operator.source§impl BitOrAssign for StateBlendFlags
impl BitOrAssign for StateBlendFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for StateBlendFlags
impl BitXor for StateBlendFlags
source§impl BitXorAssign for StateBlendFlags
impl BitXorAssign for StateBlendFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for StateBlendFlags
impl Clone for StateBlendFlags
source§fn clone(&self) -> StateBlendFlags
fn clone(&self) -> StateBlendFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StateBlendFlags
impl Debug for StateBlendFlags
source§impl Extend<StateBlendFlags> for StateBlendFlags
impl Extend<StateBlendFlags> for StateBlendFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<StateBlendFlags> for StateBlendFlags
impl FromIterator<StateBlendFlags> for StateBlendFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for StateBlendFlags
impl Hash for StateBlendFlags
source§impl LowerHex for StateBlendFlags
impl LowerHex for StateBlendFlags
source§impl Not for StateBlendFlags
impl Not for StateBlendFlags
source§impl Octal for StateBlendFlags
impl Octal for StateBlendFlags
source§impl Ord for StateBlendFlags
impl Ord for StateBlendFlags
source§fn cmp(&self, other: &StateBlendFlags) -> Ordering
fn cmp(&self, other: &StateBlendFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for StateBlendFlags
impl PartialEq for StateBlendFlags
source§fn eq(&self, other: &StateBlendFlags) -> bool
fn eq(&self, other: &StateBlendFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for StateBlendFlags
impl PartialOrd for StateBlendFlags
source§fn partial_cmp(&self, other: &StateBlendFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StateBlendFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for StateBlendFlags
impl Sub for StateBlendFlags
source§impl SubAssign for StateBlendFlags
impl SubAssign for StateBlendFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.