Struct physx_sys::PxHeightFieldFlags
source · pub struct PxHeightFieldFlags { /* private fields */ }
Expand description
Flags for PxHeightFieldFlag
Implementations§
source§impl PxHeightFieldFlags
impl PxHeightFieldFlags
pub const NoBoundaryEdges: 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 PxHeightFieldFlags
impl Binary for PxHeightFieldFlags
source§impl BitAnd for PxHeightFieldFlags
impl BitAnd for PxHeightFieldFlags
source§impl BitAndAssign for PxHeightFieldFlags
impl BitAndAssign for PxHeightFieldFlags
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 PxHeightFieldFlags
impl BitOr for PxHeightFieldFlags
source§fn bitor(self, other: PxHeightFieldFlags) -> Self
fn bitor(self, other: PxHeightFieldFlags) -> Self
Returns the union of the two sets of flags.
§type Output = PxHeightFieldFlags
type Output = PxHeightFieldFlags
|
operator.source§impl BitOrAssign for PxHeightFieldFlags
impl BitOrAssign for PxHeightFieldFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for PxHeightFieldFlags
impl BitXor for PxHeightFieldFlags
source§impl BitXorAssign for PxHeightFieldFlags
impl BitXorAssign for PxHeightFieldFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for PxHeightFieldFlags
impl Clone for PxHeightFieldFlags
source§fn clone(&self) -> PxHeightFieldFlags
fn clone(&self) -> PxHeightFieldFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PxHeightFieldFlags
impl Debug for PxHeightFieldFlags
source§impl Default for PxHeightFieldFlags
impl Default for PxHeightFieldFlags
source§fn default() -> PxHeightFieldFlags
fn default() -> PxHeightFieldFlags
source§impl Extend<PxHeightFieldFlags> for PxHeightFieldFlags
impl Extend<PxHeightFieldFlags> for PxHeightFieldFlags
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<PxHeightFieldFlags> for PxHeightFieldFlags
impl FromIterator<PxHeightFieldFlags> for PxHeightFieldFlags
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 PxHeightFieldFlags
impl Hash for PxHeightFieldFlags
source§impl LowerHex for PxHeightFieldFlags
impl LowerHex for PxHeightFieldFlags
source§impl Not for PxHeightFieldFlags
impl Not for PxHeightFieldFlags
source§impl Octal for PxHeightFieldFlags
impl Octal for PxHeightFieldFlags
source§impl Ord for PxHeightFieldFlags
impl Ord for PxHeightFieldFlags
source§fn cmp(&self, other: &PxHeightFieldFlags) -> Ordering
fn cmp(&self, other: &PxHeightFieldFlags) -> 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 PxHeightFieldFlags
impl PartialEq for PxHeightFieldFlags
source§fn eq(&self, other: &PxHeightFieldFlags) -> bool
fn eq(&self, other: &PxHeightFieldFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for PxHeightFieldFlags
impl PartialOrd for PxHeightFieldFlags
source§fn partial_cmp(&self, other: &PxHeightFieldFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &PxHeightFieldFlags) -> 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 PxHeightFieldFlags
impl Sub for PxHeightFieldFlags
source§impl SubAssign for PxHeightFieldFlags
impl SubAssign for PxHeightFieldFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.