Struct physx_sys::PxBaseFlags
source · pub struct PxBaseFlags { /* private fields */ }
Expand description
Flags for PxBaseFlag
Implementations§
source§impl PxBaseFlags
impl PxBaseFlags
pub const OwnsMemory: Self = _
pub const IsReleasable: Self = _
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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 PxBaseFlags
impl Binary for PxBaseFlags
source§impl BitAnd for PxBaseFlags
impl BitAnd for PxBaseFlags
source§impl BitAndAssign for PxBaseFlags
impl BitAndAssign for PxBaseFlags
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 PxBaseFlags
impl BitOr for PxBaseFlags
source§fn bitor(self, other: PxBaseFlags) -> Self
fn bitor(self, other: PxBaseFlags) -> Self
Returns the union of the two sets of flags.
§type Output = PxBaseFlags
type Output = PxBaseFlags
|
operator.source§impl BitOrAssign for PxBaseFlags
impl BitOrAssign for PxBaseFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for PxBaseFlags
impl BitXor for PxBaseFlags
source§impl BitXorAssign for PxBaseFlags
impl BitXorAssign for PxBaseFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for PxBaseFlags
impl Clone for PxBaseFlags
source§fn clone(&self) -> PxBaseFlags
fn clone(&self) -> PxBaseFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PxBaseFlags
impl Debug for PxBaseFlags
source§impl Default for PxBaseFlags
impl Default for PxBaseFlags
source§fn default() -> PxBaseFlags
fn default() -> PxBaseFlags
source§impl Extend<PxBaseFlags> for PxBaseFlags
impl Extend<PxBaseFlags> for PxBaseFlags
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<PxBaseFlags> for PxBaseFlags
impl FromIterator<PxBaseFlags> for PxBaseFlags
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 PxBaseFlags
impl Hash for PxBaseFlags
source§impl LowerHex for PxBaseFlags
impl LowerHex for PxBaseFlags
source§impl Not for PxBaseFlags
impl Not for PxBaseFlags
source§impl Octal for PxBaseFlags
impl Octal for PxBaseFlags
source§impl Ord for PxBaseFlags
impl Ord for PxBaseFlags
source§fn cmp(&self, other: &PxBaseFlags) -> Ordering
fn cmp(&self, other: &PxBaseFlags) -> 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 PxBaseFlags
impl PartialEq for PxBaseFlags
source§fn eq(&self, other: &PxBaseFlags) -> bool
fn eq(&self, other: &PxBaseFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for PxBaseFlags
impl PartialOrd for PxBaseFlags
source§fn partial_cmp(&self, other: &PxBaseFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &PxBaseFlags) -> 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 PxBaseFlags
impl Sub for PxBaseFlags
source§impl SubAssign for PxBaseFlags
impl SubAssign for PxBaseFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.