Struct SDL_HapticPeriodic

#[repr(C)]
pub struct SDL_HapticPeriodic {

    pub type_: u16,
    pub direction: SDL_HapticDirection,
    pub length: u32,
    pub delay: u16,
    pub button: u16,
    pub interval: u16,
    pub period: u16,
    pub magnitude: i16,
    pub offset: i16,
    pub phase: u16,
    pub attack_length: u16,
    pub attack_level: u16,
    pub fade_length: u16,
    pub fade_level: u16,
}

Available on crate feature dep_sdl2 only.

\brief A structure containing a template for a Periodic effect.

The struct handles the following effects:

• ::SDL_HAPTIC_SINE
• ::SDL_HAPTIC_LEFTRIGHT
• ::SDL_HAPTIC_TRIANGLE
• ::SDL_HAPTIC_SAWTOOTHUP
• ::SDL_HAPTIC_SAWTOOTHDOWN

A periodic effect consists in a wave-shaped effect that repeats itself over time. The type determines the shape of the wave and the parameters determine the dimensions of the wave.

Phase is given by hundredth of a degree meaning that giving the phase a value of 9000 will displace it 25% of its period. Here are sample values:

• 0: No phase displacement.

• 9000: Displaced 25% of its period.
• 18000: Displaced 50% of its period.
• 27000: Displaced 75% of its period.
• 36000: Displaced 100% of its period, same as 0, but 0 is preferred.

Examples: \verbatim SDL_HAPTIC_SINE

---

/ \ / \ / \ / / _/ _/ __/

SDL_HAPTIC_SQUARE

---

| | | | | | | | | | | || || || || |

SDL_HAPTIC_TRIANGLE /\ /\ /\ /\ /
/ \ / \ / \ / \ / / / / / /

SDL_HAPTIC_SAWTOOTHUP /| /| /| /| /| /| /| / | / | / | / | / | / | / | / |/ |/ |/ |/ |/ |/ |

SDL_HAPTIC_SAWTOOTHDOWN \ |\ |\ |\ |\ |\ |\ | \ | \ | \ | \ | \ | \ | \ | | | | | | | | \endverbatim

\sa SDL_HAPTIC_SINE \sa SDL_HAPTIC_LEFTRIGHT \sa SDL_HAPTIC_TRIANGLE \sa SDL_HAPTIC_SAWTOOTHUP \sa SDL_HAPTIC_SAWTOOTHDOWN \sa SDL_HapticEffect

Fields

type_: u16

< ::SDL_HAPTIC_SINE, ::SDL_HAPTIC_LEFTRIGHT, ::SDL_HAPTIC_TRIANGLE, ::SDL_HAPTIC_SAWTOOTHUP or ::SDL_HAPTIC_SAWTOOTHDOWN

direction: SDL_HapticDirection

< Direction of the effect.

length: u32

< Duration of the effect.

delay: u16

< Delay before starting the effect.

button: u16

< Button that triggers the effect.

interval: u16

< How soon it can be triggered again after button.

period: u16

< Period of the wave.

magnitude: i16

< Peak value; if negative, equivalent to 180 degrees extra phase shift.

offset: i16

< Mean value of the wave.

phase: u16

< Positive phase shift given by hundredth of a degree.

attack_length: u16

< Duration of the attack.

attack_level: u16

< Level at the start of the attack.

fade_length: u16

< Duration of the fade.

fade_level: u16

< Level at the end of the fade.

Trait Implementations

impl Clone for SDL_HapticPeriodic

fn clone(&self) -> SDL_HapticPeriodic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SDL_HapticPeriodic