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:

• 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 cyle meaning that giving the phase a value of 9000 will displace it 25% of it's period. Here are sample values:

• 0: No phase displacement.
• 9000: Displaced 25% of it's period.
• 18000: Displaced 50% of it's period.
• 27000: Displaced 75% of it's period.
• 36000: Displaced 100% of it's period, same as 0, but 0 is preffered.

Examples:

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

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

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

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

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

See also:

SDL_HAPTIC_SINE

SDL_HAPTIC_SQUARE

SDL_HAPTIC_TRIANGLE

SDL_HAPTIC_SAWTOOTHUP

SDL_HAPTIC_SAWTOOTHDOWN

SDL_HapticEffect

---

Field Documentation

Uint16 attack_length

Duration of the attack.

Uint16 attack_level

Level at the start of the attack.

Uint16 button

Button that triggers the effect.

Uint16 delay

Delay before starting the effect.

SDL_HapticDirection direction

Direction of the effect.

Uint16 fade_length

Duration of the fade.

Uint16 fade_level

Level at the end of the fade.

Uint16 interval

How soon it can be triggered again after button.

Uint32 length

Duration of the effect.

Sint16 magnitude

Peak value.

Sint16 offset

Mean value of the wave.

Uint16 period

Period of the wave.

Uint16 phase

Horizontal shift given by hundredth of a cycle.

Uint16 type

SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE, SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or SDL_HAPTIC_SAWTOOTHDOWN

---

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

• /Users/hercules/trunk/SDL/include/SDL_haptic.h