SDL 3.0
|
#include <SDL_haptic.h>
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:
Definition at line 641 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::attack_length |
Duration of the attack.
Definition at line 664 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::attack_level |
Level at the start of the attack.
Definition at line 665 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::button |
Button that triggers the effect.
Definition at line 654 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::delay |
Delay before starting the effect.
Definition at line 651 of file SDL_haptic.h.
SDL_HapticDirection SDL_HapticPeriodic::direction |
Direction of the effect.
Definition at line 647 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::fade_length |
Duration of the fade.
Definition at line 666 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::fade_level |
Level at the end of the fade.
Definition at line 667 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::interval |
How soon it can be triggered again after button.
Definition at line 655 of file SDL_haptic.h.
Uint32 SDL_HapticPeriodic::length |
Duration of the effect.
Definition at line 650 of file SDL_haptic.h.
Sint16 SDL_HapticPeriodic::magnitude |
Peak value; if negative, equivalent to 180 degrees extra phase shift.
Definition at line 659 of file SDL_haptic.h.
Sint16 SDL_HapticPeriodic::offset |
Mean value of the wave.
Definition at line 660 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::period |
Period of the wave.
Definition at line 658 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::phase |
Positive phase shift given by hundredth of a degree.
Definition at line 661 of file SDL_haptic.h.
Uint16 SDL_HapticPeriodic::type |
SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or SDL_HAPTIC_SAWTOOTHDOWN
Definition at line 644 of file SDL_haptic.h.