Commit a5ce9c111320fa7159b16ecda88b2d29dfd119e5
2014-11-29T11:49:58
Fixed bug 2766 - Haptic coding bugs and fixes for Linux FF: periodic.phase handled as time instead of angle; + direction clarification Elias Vanderstuyft "Horizontal" is not very precise, use "Positive phase" instead. "Positive" because it's actually waveform(2*pi*t + phase) instead of waveform(2*pi*t - phase).
diff --git a/include/SDL_haptic.h b/include/SDL_haptic.h
index eb87d68..b667112 100644
--- a/include/SDL_haptic.h
+++ b/include/SDL_haptic.h
@@ -558,7 +558,7 @@ typedef struct SDL_HapticPeriodic
Uint16 period; /**< Period of the wave. */
Sint16 magnitude; /**< Peak value; if negative, equivalent to 180 degrees extra phase shift. */
Sint16 offset; /**< Mean value of the wave. */
- Uint16 phase; /**< Horizontal shift given by hundredth of a degree. */
+ Uint16 phase; /**< Positive phase shift given by hundredth of a degree. */
/* Envelope */
Uint16 attack_length; /**< Duration of the attack. */