include/SDL_haptic.h
changeset 13789 a359f4f93439
parent 13645 f7fc52b64177
equal deleted inserted replaced
13788:56eb55f090f3 13789:a359f4f93439
   335  *  \sa SDL_HapticDirection
   335  *  \sa SDL_HapticDirection
   336  */
   336  */
   337 #define SDL_HAPTIC_SPHERICAL  2
   337 #define SDL_HAPTIC_SPHERICAL  2
   338 
   338 
   339 /**
   339 /**
   340  *  \brief Uses first axis only.
   340  *  \brief Use this value to play an effect on the steering wheel axis. This 
   341  *  For some device with only one axis (steering wheel,...),
   341  *  provides better compatibility across platforms and devices as SDL will guess 
   342  *  SDL_HAPTIC_CARTESIAN does not work. SDL_HAPTIC_FIRST_AXIS can be used in 
   342  *  the correct axis.
   343  *  this case.
       
   344  *  Using SDL_HAPTIC_FIRST_AXIS is equivalent to :
       
   345  *  \code
       
   346  *  SDL_HapticDirection direction;
       
   347  *  direction.type = SDL_HAPTIC_CARTESIAN;
       
   348  *  direction.dir[0] = 1;
       
   349  *  direction.dir[1] = 0;
       
   350  *  direction.dir[2] = 0;
       
   351  *  \endcode
       
   352  *  \sa SDL_HapticDirection
   343  *  \sa SDL_HapticDirection
   353  */
   344  */
   354 #define SDL_HAPTIC_FIRST_AXIS 3
   345 #define SDL_HAPTIC_STEERING_AXIS 3
   355 
   346 
   356 /* @} *//* Direction encodings */
   347 /* @} *//* Direction encodings */
   357 
   348 
   358 /* @} *//* Haptic features */
   349 /* @} *//* Haptic features */
   359 
   350 
   459  *  \endcode
   450  *  \endcode
   460  *
   451  *
   461  *  \sa SDL_HAPTIC_POLAR
   452  *  \sa SDL_HAPTIC_POLAR
   462  *  \sa SDL_HAPTIC_CARTESIAN
   453  *  \sa SDL_HAPTIC_CARTESIAN
   463  *  \sa SDL_HAPTIC_SPHERICAL
   454  *  \sa SDL_HAPTIC_SPHERICAL
   464  *  \sa SDL_HAPTIC_FIRST_AXIS
   455  *  \sa SDL_HAPTIC_STEERING_AXIS
   465  *  \sa SDL_HapticEffect
   456  *  \sa SDL_HapticEffect
   466  *  \sa SDL_HapticNumAxes
   457  *  \sa SDL_HapticNumAxes
   467  */
   458  */
   468 typedef struct SDL_HapticDirection
   459 typedef struct SDL_HapticDirection
   469 {
   460 {