include/SDL_haptic.h
branchgsoc2008_force_feedback
changeset 2512 ef147ee4896c
parent 2511 f12ae0bae468
child 2515 030fc4375e63
equal deleted inserted replaced
2511:f12ae0bae468 2512:ef147ee4896c
   636  *
   636  *
   637  *    \param device_index Index of the device to open.
   637  *    \param device_index Index of the device to open.
   638  *    \return Device identifier or NULL on error.
   638  *    \return Device identifier or NULL on error.
   639  *
   639  *
   640  * \sa SDL_HapticIndex
   640  * \sa SDL_HapticIndex
       
   641  * \sa SDL_HapticOpenFromMouse
   641  * \sa SDL_HapticOpenFromJoystick
   642  * \sa SDL_HapticOpenFromJoystick
   642  * \sa SDL_HapticClose
   643  * \sa SDL_HapticClose
   643  * \sa SDL_HapticSetGain
   644  * \sa SDL_HapticSetGain
   644  * \sa SDL_HapticSetAutocenter
   645  * \sa SDL_HapticSetAutocenter
   645  */
   646  */
   668  *
   669  *
   669  * \sa SDL_HapticOpen
   670  * \sa SDL_HapticOpen
   670  * \sa SDL_HapticOpened
   671  * \sa SDL_HapticOpened
   671  */
   672  */
   672 extern DECLSPEC int SDL_HapticIndex(SDL_Haptic * haptic);
   673 extern DECLSPEC int SDL_HapticIndex(SDL_Haptic * haptic);
       
   674 
       
   675 /**
       
   676  * \fn int SDL_MouseIsHaptic(void)
       
   677  *
       
   678  * \brief Gets whether or not the current mouse has haptic capabilities.
       
   679  *
       
   680  *    \return SDL_TRUE if the mouse is haptic, SDL_FALSE if it isn't.
       
   681  *
       
   682  * \sa SDL_HapticOpenFromMouse
       
   683  */
       
   684 extern DECLSPEC SDL_MouseIsHaptic(void);
       
   685 
       
   686 /**
       
   687  * \fn SDL_Haptic * SDL_HapticOpenFromMouse(void)
       
   688  *
       
   689  * \brief Tries to open a haptic device from the current mouse.
       
   690  *
       
   691  *    \return The haptic device identifier or NULL on error.
       
   692  *
       
   693  * \sa SDL_MouseIsHaptic
       
   694  * \sa SDL_HapticOpen
       
   695  */
       
   696 extern DECLSPEC SDL_Haptic * SDL_HapticOpenFromMouse(void);
   673 
   697 
   674 /**
   698 /**
   675  * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
   699  * \fn int SDL_JoystickIsHaptic(SDL_Joystick * joystick)
   676  *
   700  *
   677  * \brief Checks to see if a joystick has haptic features.
   701  * \brief Checks to see if a joystick has haptic features.