Enum HapticEffect

#[non_exhaustive]
pub enum HapticEffect {
    Constant(Direction, Play, Trigger, Level, Envelope),
    Periodic(Direction, Play, Trigger, Wave, Envelope),
    Condition(Play, Trigger, Condition),
    Ramp(Direction, Play, Trigger, Ramp, Envelope),
    LeftRight {
        length: u32,
        large_magnitude: u16,
        small_magnitude: u16,
    },
    Custom(Direction, Play, Trigger, Custom, Envelope),
}

An effect on the haptic device.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Constant(Direction, Play, Trigger, Level, Envelope)

Applies the constant force in the direction.

Periodic(Direction, Play, Trigger, Wave, Envelope)

Applies the force of the periodic waveform.

Condition(Play, Trigger, Condition)

Applies the force on fulfilled the condition.

Ramp(Direction, Play, Trigger, Ramp, Envelope)

Applies the force by linear ramp.

LeftRight

Applies the left/right effect with two motors magnitude. One motor is high frequency, the other is low frequency.

Fields

length: u32

The length of the playing in milliseconds.

large_magnitude: u16

The magnitude for the large motor.

small_magnitude: u16

The magnitude for the small motor.

Custom(Direction, Play, Trigger, Custom, Envelope)

Applies the force of the periodic waveform from your sampled data.

Trait Implementations

impl Clone for HapticEffect

fn clone(&self) -> HapticEffect

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HapticEffect

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<SDL_HapticEffect> for HapticEffect

fn from(raw: SDL_HapticEffect) -> Self

Converts to this type from the input type.

impl PartialEq for HapticEffect

fn eq(&self, other: &HapticEffect) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HapticEffect

impl StructuralPartialEq for HapticEffect