Documenting special cases. gsoc2008_force_feedback
authorEdgar Simo <bobbens@gmail.com>
Wed, 06 Aug 2008 09:35:09 +0000
branchgsoc2008_force_feedback
changeset 2622446054caaa81
parent 2621 83659de20bf2
child 2623 6deba05725ac
Documenting special cases.
include/SDL_haptic.h
     1.1 --- a/include/SDL_haptic.h	Wed Aug 06 09:28:07 2008 +0000
     1.2 +++ b/include/SDL_haptic.h	Wed Aug 06 09:35:09 2008 +0000
     1.3 @@ -826,6 +826,11 @@
     1.4   * \brief Opens a Haptic device for usage from a Joystick device.  Still has
     1.5   * to be closed seperately to the joystick.
     1.6   *
     1.7 + * When opening from a joystick you should first close the haptic device before
     1.8 + *  closing the joystick device.  If not, on some implementations the haptic
     1.9 + *  device will also get unallocated and you'll be unable to use force feedback
    1.10 + *  on that device.
    1.11 + *
    1.12   *    \param joystick Joystick to create a haptic device from.
    1.13   *    \return A valid haptic device identifier on success or NULL on error.
    1.14   *