Struct bgfx_rs::static_lib::CubeMapFlags
source · pub struct CubeMapFlags { /* private fields */ }
Implementations§
source§impl CubeMapFlags
impl CubeMapFlags
sourcepub const POSITIVE_X: Self = _
pub const POSITIVE_X: Self = _
Cubemap +x.
sourcepub const NEGATIVE_X: Self = _
pub const NEGATIVE_X: Self = _
Cubemap -x.
sourcepub const POSITIVE_Y: Self = _
pub const POSITIVE_Y: Self = _
Cubemap +y.
sourcepub const NEGATIVE_Y: Self = _
pub const NEGATIVE_Y: Self = _
Cubemap -y.
sourcepub const POSITIVE_Z: Self = _
pub const POSITIVE_Z: Self = _
Cubemap +z.
sourcepub const NEGATIVE_Z: Self = _
pub const NEGATIVE_Z: Self = _
Cubemap -z.
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§
source§impl Binary for CubeMapFlags
impl Binary for CubeMapFlags
source§impl BitAnd for CubeMapFlags
impl BitAnd for CubeMapFlags
source§impl BitAndAssign for CubeMapFlags
impl BitAndAssign for CubeMapFlags
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 CubeMapFlags
impl BitOr for CubeMapFlags
source§fn bitor(self, other: CubeMapFlags) -> Self
fn bitor(self, other: CubeMapFlags) -> Self
Returns the union of the two sets of flags.
§type Output = CubeMapFlags
type Output = CubeMapFlags
|
operator.source§impl BitOrAssign for CubeMapFlags
impl BitOrAssign for CubeMapFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for CubeMapFlags
impl BitXor for CubeMapFlags
source§impl BitXorAssign for CubeMapFlags
impl BitXorAssign for CubeMapFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for CubeMapFlags
impl Clone for CubeMapFlags
source§fn clone(&self) -> CubeMapFlags
fn clone(&self) -> CubeMapFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CubeMapFlags
impl Debug for CubeMapFlags
source§impl Extend<CubeMapFlags> for CubeMapFlags
impl Extend<CubeMapFlags> for CubeMapFlags
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<CubeMapFlags> for CubeMapFlags
impl FromIterator<CubeMapFlags> for CubeMapFlags
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 CubeMapFlags
impl Hash for CubeMapFlags
source§impl LowerHex for CubeMapFlags
impl LowerHex for CubeMapFlags
source§impl Not for CubeMapFlags
impl Not for CubeMapFlags
source§impl Octal for CubeMapFlags
impl Octal for CubeMapFlags
source§impl Ord for CubeMapFlags
impl Ord for CubeMapFlags
source§fn cmp(&self, other: &CubeMapFlags) -> Ordering
fn cmp(&self, other: &CubeMapFlags) -> 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 CubeMapFlags
impl PartialEq for CubeMapFlags
source§fn eq(&self, other: &CubeMapFlags) -> bool
fn eq(&self, other: &CubeMapFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for CubeMapFlags
impl PartialOrd for CubeMapFlags
source§fn partial_cmp(&self, other: &CubeMapFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &CubeMapFlags) -> 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 CubeMapFlags
impl Sub for CubeMapFlags
source§impl SubAssign for CubeMapFlags
impl SubAssign for CubeMapFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.