Struct physx::visual_debugger::InstrumentationFlags
source · pub struct InstrumentationFlags { /* private fields */ }
Expand description
Flags for PxPvdInstrumentationFlag
Implementations§
source§impl PxPvdInstrumentationFlags
impl PxPvdInstrumentationFlags
pub const Debug: PxPvdInstrumentationFlags = Self{ bits: 1 << 0,}
pub const Profile: PxPvdInstrumentationFlags = Self{ bits: 1 << 1,}
pub const Memory: PxPvdInstrumentationFlags = Self{ bits: 1 << 2,}
pub const All: PxPvdInstrumentationFlags = Self{ bits: Self::Debug.bits | Self::Profile.bits | Self::Memory.bits,}
sourcepub const fn empty() -> PxPvdInstrumentationFlags
pub const fn empty() -> PxPvdInstrumentationFlags
Returns an empty set of flags.
sourcepub const fn all() -> PxPvdInstrumentationFlags
pub const fn all() -> PxPvdInstrumentationFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<PxPvdInstrumentationFlags>
pub const fn from_bits(bits: u8) -> Option<PxPvdInstrumentationFlags>
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) -> PxPvdInstrumentationFlags
pub const fn from_bits_truncate(bits: u8) -> PxPvdInstrumentationFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> PxPvdInstrumentationFlags
pub const unsafe fn from_bits_unchecked(bits: u8) -> PxPvdInstrumentationFlags
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: PxPvdInstrumentationFlags) -> bool
pub const fn intersects(&self, other: PxPvdInstrumentationFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: PxPvdInstrumentationFlags) -> bool
pub const fn contains(&self, other: PxPvdInstrumentationFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: PxPvdInstrumentationFlags)
pub fn insert(&mut self, other: PxPvdInstrumentationFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: PxPvdInstrumentationFlags)
pub fn remove(&mut self, other: PxPvdInstrumentationFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: PxPvdInstrumentationFlags)
pub fn toggle(&mut self, other: PxPvdInstrumentationFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: PxPvdInstrumentationFlags, value: bool)
pub fn set(&mut self, other: PxPvdInstrumentationFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(
self,
other: PxPvdInstrumentationFlags
) -> PxPvdInstrumentationFlags
pub const fn intersection( self, other: PxPvdInstrumentationFlags ) -> PxPvdInstrumentationFlags
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: PxPvdInstrumentationFlags
) -> PxPvdInstrumentationFlags
pub const fn union( self, other: PxPvdInstrumentationFlags ) -> PxPvdInstrumentationFlags
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: PxPvdInstrumentationFlags
) -> PxPvdInstrumentationFlags
pub const fn difference( self, other: PxPvdInstrumentationFlags ) -> PxPvdInstrumentationFlags
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: PxPvdInstrumentationFlags
) -> PxPvdInstrumentationFlags
pub const fn symmetric_difference( self, other: PxPvdInstrumentationFlags ) -> PxPvdInstrumentationFlags
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) -> PxPvdInstrumentationFlags
pub const fn complement(self) -> PxPvdInstrumentationFlags
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 PxPvdInstrumentationFlags
impl Binary for PxPvdInstrumentationFlags
source§impl BitAnd<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl BitAnd<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn bitand(self, other: PxPvdInstrumentationFlags) -> PxPvdInstrumentationFlags
fn bitand(self, other: PxPvdInstrumentationFlags) -> PxPvdInstrumentationFlags
Returns the intersection between the two sets of flags.
§type Output = PxPvdInstrumentationFlags
type Output = PxPvdInstrumentationFlags
&
operator.source§impl BitAndAssign<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl BitAndAssign<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn bitand_assign(&mut self, other: PxPvdInstrumentationFlags)
fn bitand_assign(&mut self, other: PxPvdInstrumentationFlags)
Disables all flags disabled in the set.
source§impl BitOr<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl BitOr<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn bitor(self, other: PxPvdInstrumentationFlags) -> PxPvdInstrumentationFlags
fn bitor(self, other: PxPvdInstrumentationFlags) -> PxPvdInstrumentationFlags
Returns the union of the two sets of flags.
§type Output = PxPvdInstrumentationFlags
type Output = PxPvdInstrumentationFlags
|
operator.source§impl BitOrAssign<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl BitOrAssign<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn bitor_assign(&mut self, other: PxPvdInstrumentationFlags)
fn bitor_assign(&mut self, other: PxPvdInstrumentationFlags)
Adds the set of flags.
source§impl BitXor<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl BitXor<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn bitxor(self, other: PxPvdInstrumentationFlags) -> PxPvdInstrumentationFlags
fn bitxor(self, other: PxPvdInstrumentationFlags) -> PxPvdInstrumentationFlags
Returns the left flags, but with all the right flags toggled.
§type Output = PxPvdInstrumentationFlags
type Output = PxPvdInstrumentationFlags
^
operator.source§impl BitXorAssign<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl BitXorAssign<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn bitxor_assign(&mut self, other: PxPvdInstrumentationFlags)
fn bitxor_assign(&mut self, other: PxPvdInstrumentationFlags)
Toggles the set of flags.
source§impl Clone for PxPvdInstrumentationFlags
impl Clone for PxPvdInstrumentationFlags
source§fn clone(&self) -> PxPvdInstrumentationFlags
fn clone(&self) -> PxPvdInstrumentationFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PxPvdInstrumentationFlags
impl Debug for PxPvdInstrumentationFlags
source§impl Default for PxPvdInstrumentationFlags
impl Default for PxPvdInstrumentationFlags
source§fn default() -> PxPvdInstrumentationFlags
fn default() -> PxPvdInstrumentationFlags
source§impl Extend<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl Extend<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = PxPvdInstrumentationFlags>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = PxPvdInstrumentationFlags>,
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<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl FromIterator<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn from_iter<T>(iterator: T) -> PxPvdInstrumentationFlagswhere
T: IntoIterator<Item = PxPvdInstrumentationFlags>,
fn from_iter<T>(iterator: T) -> PxPvdInstrumentationFlagswhere T: IntoIterator<Item = PxPvdInstrumentationFlags>,
source§impl Hash for PxPvdInstrumentationFlags
impl Hash for PxPvdInstrumentationFlags
source§impl LowerHex for PxPvdInstrumentationFlags
impl LowerHex for PxPvdInstrumentationFlags
source§impl Not for PxPvdInstrumentationFlags
impl Not for PxPvdInstrumentationFlags
source§fn not(self) -> PxPvdInstrumentationFlags
fn not(self) -> PxPvdInstrumentationFlags
Returns the complement of this set of flags.
§type Output = PxPvdInstrumentationFlags
type Output = PxPvdInstrumentationFlags
!
operator.source§impl Octal for PxPvdInstrumentationFlags
impl Octal for PxPvdInstrumentationFlags
source§impl Ord for PxPvdInstrumentationFlags
impl Ord for PxPvdInstrumentationFlags
source§fn cmp(&self, other: &PxPvdInstrumentationFlags) -> Ordering
fn cmp(&self, other: &PxPvdInstrumentationFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl PartialEq<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn eq(&self, other: &PxPvdInstrumentationFlags) -> bool
fn eq(&self, other: &PxPvdInstrumentationFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl PartialOrd<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn partial_cmp(&self, other: &PxPvdInstrumentationFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &PxPvdInstrumentationFlags) -> 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<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl Sub<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn sub(self, other: PxPvdInstrumentationFlags) -> PxPvdInstrumentationFlags
fn sub(self, other: PxPvdInstrumentationFlags) -> PxPvdInstrumentationFlags
Returns the set difference of the two sets of flags.
§type Output = PxPvdInstrumentationFlags
type Output = PxPvdInstrumentationFlags
-
operator.source§impl SubAssign<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
impl SubAssign<PxPvdInstrumentationFlags> for PxPvdInstrumentationFlags
source§fn sub_assign(&mut self, other: PxPvdInstrumentationFlags)
fn sub_assign(&mut self, other: PxPvdInstrumentationFlags)
Disables all flags enabled in the set.