include/SDL_haptic.h
changeset 13789 a359f4f93439
parent 13645 f7fc52b64177
     1.1 --- a/include/SDL_haptic.h	Mon May 04 10:16:10 2020 -0700
     1.2 +++ b/include/SDL_haptic.h	Mon May 04 13:17:43 2020 -0700
     1.3 @@ -337,21 +337,12 @@
     1.4  #define SDL_HAPTIC_SPHERICAL  2
     1.5  
     1.6  /**
     1.7 - *  \brief Uses first axis only.
     1.8 - *  For some device with only one axis (steering wheel,...),
     1.9 - *  SDL_HAPTIC_CARTESIAN does not work. SDL_HAPTIC_FIRST_AXIS can be used in 
    1.10 - *  this case.
    1.11 - *  Using SDL_HAPTIC_FIRST_AXIS is equivalent to :
    1.12 - *  \code
    1.13 - *  SDL_HapticDirection direction;
    1.14 - *  direction.type = SDL_HAPTIC_CARTESIAN;
    1.15 - *  direction.dir[0] = 1;
    1.16 - *  direction.dir[1] = 0;
    1.17 - *  direction.dir[2] = 0;
    1.18 - *  \endcode
    1.19 + *  \brief Use this value to play an effect on the steering wheel axis. This 
    1.20 + *  provides better compatibility across platforms and devices as SDL will guess 
    1.21 + *  the correct axis.
    1.22   *  \sa SDL_HapticDirection
    1.23   */
    1.24 -#define SDL_HAPTIC_FIRST_AXIS 3
    1.25 +#define SDL_HAPTIC_STEERING_AXIS 3
    1.26  
    1.27  /* @} *//* Direction encodings */
    1.28  
    1.29 @@ -461,7 +452,7 @@
    1.30   *  \sa SDL_HAPTIC_POLAR
    1.31   *  \sa SDL_HAPTIC_CARTESIAN
    1.32   *  \sa SDL_HAPTIC_SPHERICAL
    1.33 - *  \sa SDL_HAPTIC_FIRST_AXIS
    1.34 + *  \sa SDL_HAPTIC_STEERING_AXIS
    1.35   *  \sa SDL_HapticEffect
    1.36   *  \sa SDL_HapticNumAxes
    1.37   */