My Project
Loading...
Searching...
No Matches
SDL_HapticPeriodic Struct Reference

A structure containing a template for a Periodic effect. More...

#include <SDL_haptic.h>

Data Fields

Uint16 type
 
SDL_HapticDirection direction
 
Uint32 length
 
Uint16 delay
 
Uint16 button
 
Uint16 interval
 
Uint16 period
 
Sint16 magnitude
 
Sint16 offset
 
Uint16 phase
 
Uint16 attack_length
 
Uint16 attack_level
 
Uint16 fade_length
 
Uint16 fade_level
 

Detailed Description

A structure containing a template for a Periodic effect.

The struct handles the following effects:

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
\  |\  |\  |\  |\  |\  |\  |
 \ | \ | \ | \ | \ | \ | \ |
  \|  \|  \|  \|  \|  \|  \|
See also
SDL_HAPTIC_SINE
SDL_HAPTIC_LEFTRIGHT
SDL_HAPTIC_TRIANGLE
SDL_HAPTIC_SAWTOOTHUP
SDL_HAPTIC_SAWTOOTHDOWN
SDL_HapticEffect

Field Documentation

◆ attack_length

Uint16 attack_length

Duration of the attack.

◆ attack_level

Uint16 attack_level

Level at the start of the attack.

◆ button

Uint16 button

Button that triggers the effect.

◆ delay

Uint16 delay

Delay before starting the effect.

◆ direction

Direction of the effect.

◆ fade_length

Uint16 fade_length

Duration of the fade.

◆ fade_level

Uint16 fade_level

Level at the end of the fade.

◆ interval

Uint16 interval

How soon it can be triggered again after button.

◆ length

Uint32 length

Duration of the effect.

◆ magnitude

Sint16 magnitude

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

◆ offset

Sint16 offset

Mean value of the wave.

◆ period

Uint16 period

Period of the wave.

◆ phase

Uint16 phase

Positive phase shift given by hundredth of a degree.

◆ type


The documentation for this struct was generated from the following file: