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