encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed haptic documentation typos (thanks, Elias!). 

Partially fixes Bugzilla #2701.
This commit is contained in:
Ryan C. Gordon 2014-09-17 14:47:42 -04:00
parent 4544343b3e
commit 266c0023da
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/SDL_haptic.h
View File

@ -492,7 +492,7 @@ typedef struct SDL_HapticConstant
* over time. The type determines the shape of the wave and the parameters * over time. The type determines the shape of the wave and the parameters
* determine the dimensions of the wave. * determine the dimensions of the wave.
* *
* Phase is given by hundredth of a cycle meaning that giving the phase a value * 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: * of 9000 will displace it 25% of its period. Here are sample values:
* - 0: No phase displacement. * - 0: No phase displacement.
* - 9000: Displaced 25% of its period. * - 9000: Displaced 25% of its period.
@ -555,7 +555,7 @@ typedef struct SDL_HapticPeriodic
Uint16 period; /**< Period of the wave. */ Uint16 period; /**< Period of the wave. */
Sint16 magnitude; /**< Peak value. */ Sint16 magnitude; /**< Peak value. */
Sint16 offset; /**< Mean value of the wave. */ Sint16 offset; /**< Mean value of the wave. */
Uint16 phase; /**< Horizontal shift given by hundredth of a cycle. */ Uint16 phase; /**< Horizontal shift given by hundredth of a degree. */
/* Envelope */ /* Envelope */
Uint16 attack_length; /**< Duration of the attack. */ Uint16 attack_length; /**< Duration of the attack. */