Duration of the attack.
Level at the start of the attack.
Button that triggers the effect.
Delay before starting the effect.
Direction of the effect.
Duration of the fade.
Level at the end of the fade.
How soon it can be triggered again after button.
Duration of the effect.
Peak value; if negative, equivalent to 180 degrees extra phase shift.
Mean value of the wave.
Period of the wave.
Positive phase shift given by hundredth of a degree.
SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or SDL_HAPTIC_SAWTOOTHDOWN
SDL_HAPTIC_SINE
__ __ __ __
/ \ / \ / \ /
/ \__/ \__/ \__/
SDL_HAPTIC_SQUARE
__ __ __ __ __
| | | | | | | | | |
| |__| |__| |__| |__| |
SDL_HAPTIC_TRIANGLE
/\ /\ /\ /\ /\
/ \ / \ / \ / \ /
/ \/ \/ \/ \/
SDL_HAPTIC_SAWTOOTHUP
/| /| /| /| /| /| /|
/ | / | / | / | / | / | / |
/ |/ |/ |/ |/ |/ |/ |
SDL_HAPTIC_SAWTOOTHDOWN
\ |\ |\ |\ |\ |\ |\ |
\ | \ | \ | \ | \ | \ | \ |
\| \| \| \| \| \| \|\since This struct is available since SDL 3.2.0.
\sa SDL_HAPTIC_SINE \sa SDL_HAPTIC_SQUARE \sa SDL_HAPTIC_TRIANGLE \sa SDL_HAPTIC_SAWTOOTHUP \sa SDL_HAPTIC_SAWTOOTHDOWN \sa SDL_HapticEffect
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 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.