class SDL2::Haptic::Periodic
A structure containing a template for a Periodic
effect.
The struct handles the following effects:
- SDL2::Haptic::SINE - SDL2::Haptic::LEFTRIGHT - SDL2::Haptic::TRIANGLE - SDL2::Haptic::SAWTOOTHUP - SDL2::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 \ |\ |\ |\ |\ |\ |\ | \ | \ | \ | \ | \ | \ | \ | \| \| \| \| \| \| \|
@sa SDL_HAPTIC_SINE @sa SDL_HAPTIC_LEFTRIGHT @sa SDL_HAPTIC_TRIANGLE @sa SDL_HAPTIC_SAWTOOTHUP @sa SDL_HAPTIC_SAWTOOTHDOWN @sa SDL_HapticEffect