Struct gilrs::ff::EffectData

pub struct EffectData {
    pub wave: Waveform,
    pub direction: Direction,
    pub period: u16,
    pub magnitude: i16,
    pub offset: i16,
    pub phase: u16,
    pub envelope: Envelope,
    pub replay: Replay,
    pub trigger: Trigger,
}

Describes wave-shaped force feedback effect that repeat itself over time.

Borrowed from SDL Documentation:

button         period
press          |     |
  ||      __    __    __    __    __    _
  ||     |  |  |  |  |  |  |  |  |  |   magnitude
  \/     |  |__|  |__|  |__|  |__|  |   _
   -----
      |            offset?
    delay          phase?

-------------------------------------
              length
===================================================
                      interval

Fields

wave: Waveform

Kind of the wave

direction: Direction

Direction of the effect

period: u16

Period of the wave in ms

magnitude: i16

Peak value

offset: i16

Mean value of the wave

phase: u16

Horizontal shift

envelope: Envelope

Envelope data

replay: Replay

Scheduling of the effect

trigger: Trigger

Trigger conditions

Trait Implementations

impl Into<ff_effect> for EffectData

fn into(self) -> ff_effect

Performs the conversion.

impl Copy for EffectData

impl Clone for EffectData

fn clone(&self) -> EffectData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for EffectData

fn eq(&self, __arg_0: &EffectData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &EffectData) -> bool

This method tests for !=.

impl Debug for EffectData

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for EffectData

fn default() -> EffectData

Returns the "default value" for a type.