include/SDL_haptic.h
branchgsoc2008_force_feedback
changeset 2622 446054caaa81
parent 2563 be2ea885d70b
child 2630 776f7f800131
equal deleted inserted replaced
2621:83659de20bf2 2622:446054caaa81
   824  * \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
   824  * \fn SDL_Haptic * SDL_HapticOpenFromJoystick(SDL_Joystick * joystick)
   825  *
   825  *
   826  * \brief Opens a Haptic device for usage from a Joystick device.  Still has
   826  * \brief Opens a Haptic device for usage from a Joystick device.  Still has
   827  * to be closed seperately to the joystick.
   827  * to be closed seperately to the joystick.
   828  *
   828  *
       
   829  * When opening from a joystick you should first close the haptic device before
       
   830  *  closing the joystick device.  If not, on some implementations the haptic
       
   831  *  device will also get unallocated and you'll be unable to use force feedback
       
   832  *  on that device.
       
   833  *
   829  *    \param joystick Joystick to create a haptic device from.
   834  *    \param joystick Joystick to create a haptic device from.
   830  *    \return A valid haptic device identifier on success or NULL on error.
   835  *    \return A valid haptic device identifier on success or NULL on error.
   831  *
   836  *
   832  * \sa SDL_HapticOpen
   837  * \sa SDL_HapticOpen
   833  * \sa SDL_HapticClose
   838  * \sa SDL_HapticClose