Struct SDL_HapticPeriodic 

#[repr(C)]
pub struct SDL_HapticPeriodic {

    pub type: SDL_HapticEffectType,
    pub direction: SDL_HapticDirection,
    pub length: Uint32,
    pub delay: Uint16,
    pub button: Uint16,
    pub interval: Uint16,
    pub period: Uint16,
    pub magnitude: Sint16,
    pub offset: Sint16,
    pub phase: Uint16,
    pub attack_length: Uint16,
    pub attack_level: Uint16,
    pub fade_length: Uint16,
    pub fade_level: Uint16,
}

A structure containing a template for a Periodic effect.

The struct handles the following effects:

• SDL_HAPTIC_SINE
• SDL_HAPTIC_SQUARE
• 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:

  SDL_HAPTIC_SINE
    __      __      __      __
   /  \    /  \    /  \    /
  /    \__/    \__/    \__/

  SDL_HAPTIC_SQUARE
   __    __    __    __    __
  |  |  |  |  |  |  |  |  |  |
  |  |__|  |__|  |__|  |__|  |

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

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

  SDL_HAPTIC_SAWTOOTHDOWN
  \  |\  |\  |\  |\  |\  |\  |
   \ | \ | \ | \ | \ | \ | \ |
    \|  \|  \|  \|  \|  \|  \|

Availability

This struct is available since SDL 3.2.0.

See also

• SDL_HAPTIC_SINE
• SDL_HAPTIC_SQUARE
• SDL_HAPTIC_TRIANGLE
• SDL_HAPTIC_SAWTOOTHUP
• SDL_HAPTIC_SAWTOOTHDOWN
• SDL_HapticEffect

Fields

type: SDL_HapticEffectType

SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or SDL_HAPTIC_SAWTOOTHDOWN

direction: SDL_HapticDirection

Direction of the effect.

length: Uint32

Duration of the effect.

delay: Uint16

Delay before starting the effect.

button: Uint16

Button that triggers the effect.

interval: Uint16

How soon it can be triggered again after button.

period: Uint16

Period of the wave.

magnitude: Sint16

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

offset: Sint16

Mean value of the wave.

phase: Uint16

Positive phase shift given by hundredth of a degree.

attack_length: Uint16

Duration of the attack.

attack_level: Uint16

Level at the start of the attack.

fade_length: Uint16

Duration of the fade.

fade_level: Uint16

Level at the end of the fade.

Trait Implementations

impl Clone for SDL_HapticPeriodic

fn clone(&self) -> SDL_HapticPeriodic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_HapticPeriodic

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

Formats the value using the given formatter.

impl Default for SDL_HapticPeriodic

fn default() -> SDL_HapticPeriodic

Returns the “default value” for a type.

impl Hash for SDL_HapticPeriodic

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SDL_HapticPeriodic

fn eq(&self, other: &SDL_HapticPeriodic) -> 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 Copy for SDL_HapticPeriodic

impl Eq for SDL_HapticPeriodic

impl StructuralPartialEq for SDL_HapticPeriodic