Fixed haptic documentation typos (thanks, Elias!).
authorRyan C. Gordon <icculus@icculus.org>
Wed, 17 Sep 2014 14:47:42 -0400
changeset 9146dbef1f283c3f
parent 9145 aa99e029b12e
child 9147 6bf589c8d549
Fixed haptic documentation typos (thanks, Elias!).

Partially fixes Bugzilla #2701.
include/SDL_haptic.h
     1.1 --- a/include/SDL_haptic.h	Wed Sep 17 11:41:12 2014 -0300
     1.2 +++ b/include/SDL_haptic.h	Wed Sep 17 14:47:42 2014 -0400
     1.3 @@ -492,7 +492,7 @@
     1.4   *  over time.  The type determines the shape of the wave and the parameters
     1.5   *  determine the dimensions of the wave.
     1.6   *
     1.7 - *  Phase is given by hundredth of a cycle meaning that giving the phase a value
     1.8 + *  Phase is given by hundredth of a degree meaning that giving the phase a value
     1.9   *  of 9000 will displace it 25% of its period.  Here are sample values:
    1.10   *   -     0: No phase displacement.
    1.11   *   -  9000: Displaced 25% of its period.
    1.12 @@ -555,7 +555,7 @@
    1.13      Uint16 period;      /**< Period of the wave. */
    1.14      Sint16 magnitude;   /**< Peak value. */
    1.15      Sint16 offset;      /**< Mean value of the wave. */
    1.16 -    Uint16 phase;       /**< Horizontal shift given by hundredth of a cycle. */
    1.17 +    Uint16 phase;       /**< Horizontal shift given by hundredth of a degree. */
    1.18  
    1.19      /* Envelope */
    1.20      Uint16 attack_length;   /**< Duration of the attack. */