My Project
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Attributes | List of all members
SDL_HapticPeriodic Struct Reference

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

#include <SDL_haptic.h>

Public Attributes

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:

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

Member Data Documentation

Uint16 SDL_HapticPeriodic::attack_length

Duration of the attack.

Uint16 SDL_HapticPeriodic::attack_level

Level at the start of the attack.

Uint16 SDL_HapticPeriodic::button

Button that triggers the effect.

Uint16 SDL_HapticPeriodic::delay

Delay before starting the effect.

SDL_HapticDirection SDL_HapticPeriodic::direction

Direction of the effect.

Uint16 SDL_HapticPeriodic::fade_length

Duration of the fade.

Uint16 SDL_HapticPeriodic::fade_level

Level at the end of the fade.

Uint16 SDL_HapticPeriodic::interval

How soon it can be triggered again after button.

Uint32 SDL_HapticPeriodic::length

Duration of the effect.

Sint16 SDL_HapticPeriodic::magnitude

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

Sint16 SDL_HapticPeriodic::offset

Mean value of the wave.

Uint16 SDL_HapticPeriodic::period

Period of the wave.

Uint16 SDL_HapticPeriodic::phase

Positive phase shift given by hundredth of a degree.

Uint16 SDL_HapticPeriodic::type

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