Struct rich_sdl2_rust::haptic::HapticProperty
source · pub struct HapticProperty(/* private fields */);
Expand description
A property of the haptic device.
Implementations§
source§impl HapticProperty
impl HapticProperty
sourcepub const LEFT_RIGHT: Self = _
pub const LEFT_RIGHT: Self = _
Supported a left/right effect.
sourcepub const SAW_TOOTH_UP: Self = _
pub const SAW_TOOTH_UP: Self = _
Supported an upwards sawtooth wave periodic effect.
sourcepub const SAW_TOOTH_DOWN: Self = _
pub const SAW_TOOTH_DOWN: Self = _
Supported a downwards sawtooth wave periodic effect.
sourcepub const AUTO_CENTER: Self = _
pub const AUTO_CENTER: Self = _
Supported setting auto-center.
source§impl HapticProperty
impl HapticProperty
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl HapticProperty
impl HapticProperty
sourcepub const fn iter(&self) -> Iter<HapticProperty>
pub const fn iter(&self) -> Iter<HapticProperty>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<HapticProperty>
pub const fn iter_names(&self) -> IterNames<HapticProperty>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl Binary for HapticProperty
impl Binary for HapticProperty
source§impl BitAnd for HapticProperty
impl BitAnd for HapticProperty
source§impl BitAndAssign for HapticProperty
impl BitAndAssign for HapticProperty
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for HapticProperty
impl BitOr for HapticProperty
source§fn bitor(self, other: HapticProperty) -> Self
fn bitor(self, other: HapticProperty) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = HapticProperty
type Output = HapticProperty
|
operator.source§impl BitOrAssign for HapticProperty
impl BitOrAssign for HapticProperty
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for HapticProperty
impl BitXor for HapticProperty
source§impl BitXorAssign for HapticProperty
impl BitXorAssign for HapticProperty
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for HapticProperty
impl Clone for HapticProperty
source§fn clone(&self) -> HapticProperty
fn clone(&self) -> HapticProperty
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for HapticProperty
impl Debug for HapticProperty
source§impl Extend<HapticProperty> for HapticProperty
impl Extend<HapticProperty> for HapticProperty
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
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 Flags for HapticProperty
impl Flags for HapticProperty
source§const FLAGS: &'static [Flag<HapticProperty>] = _
const FLAGS: &'static [Flag<HapticProperty>] = _
source§fn from_bits_retain(bits: u32) -> HapticProperty
fn from_bits_retain(bits: u32) -> HapticProperty
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<HapticProperty> for HapticProperty
impl FromIterator<HapticProperty> for HapticProperty
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for HapticProperty
impl Hash for HapticProperty
source§impl IntoIterator for HapticProperty
impl IntoIterator for HapticProperty
source§impl LowerHex for HapticProperty
impl LowerHex for HapticProperty
source§impl Not for HapticProperty
impl Not for HapticProperty
source§impl Octal for HapticProperty
impl Octal for HapticProperty
source§impl PartialEq for HapticProperty
impl PartialEq for HapticProperty
source§fn eq(&self, other: &HapticProperty) -> bool
fn eq(&self, other: &HapticProperty) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for HapticProperty
impl PublicFlags for HapticProperty
source§impl Sub for HapticProperty
impl Sub for HapticProperty
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = HapticProperty
type Output = HapticProperty
-
operator.source§impl SubAssign for HapticProperty
impl SubAssign for HapticProperty
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.