SDL Library

Dependents:   H261_decoder

Embed: (wiki syntax)

« Back to documentation index

SDL_HapticPeriodic Struct Reference

SDL_HapticPeriodic Struct Reference

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

#include <SDL_haptic.h>

Data Fields

Uint16 type
 SDL_HAPTIC_SINE, SDL_HAPTIC_LEFTRIGHT, SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or SDL_HAPTIC_SAWTOOTHDOWN
SDL_HapticDirection direction
 Direction of the effect.
Uint32 length
 Duration of the effect.
Uint16 delay
 Delay before starting the effect.
Uint16 button
 Button that triggers the effect.
Uint16 interval
 How soon it can be triggered again after button.
Uint16 period
 Period of the wave.
Sint16 magnitude
 Peak value.
Sint16 offset
 Mean value of the wave.
Uint16 phase
 Horizontal shift given by hundredth of a cycle.
Uint16 attack_length
 Duration of the attack.
Uint16 attack_level
 Level at the start of the attack.
Uint16 fade_length
 Duration of the fade.
Uint16 fade_level
 Level at the end of the fade.

Detailed Description

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 cycle 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

Definition at line 538 of file SDL_haptic.h.


Field Documentation

Duration of the attack.

Definition at line 561 of file SDL_haptic.h.

Level at the start of the attack.

Definition at line 562 of file SDL_haptic.h.

Button that triggers the effect.

Definition at line 551 of file SDL_haptic.h.

Delay before starting the effect.

Definition at line 548 of file SDL_haptic.h.

Direction of the effect.

Definition at line 544 of file SDL_haptic.h.

Duration of the fade.

Definition at line 563 of file SDL_haptic.h.

Level at the end of the fade.

Definition at line 564 of file SDL_haptic.h.

How soon it can be triggered again after button.

Definition at line 552 of file SDL_haptic.h.

Duration of the effect.

Definition at line 547 of file SDL_haptic.h.

Peak value.

Definition at line 556 of file SDL_haptic.h.

Mean value of the wave.

Definition at line 557 of file SDL_haptic.h.

Period of the wave.

Definition at line 555 of file SDL_haptic.h.

Horizontal shift given by hundredth of a cycle.

Definition at line 558 of file SDL_haptic.h.

SDL_HAPTIC_SINE, SDL_HAPTIC_LEFTRIGHT, SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or SDL_HAPTIC_SAWTOOTHDOWN

Definition at line 541 of file SDL_haptic.h.