Mercurial > sdl-ios-xcode
changeset 2630:776f7f800131 gsoc2008_force_feedback
Updating documentation about NumEffects and NumPlaying.
| author | Edgar Simo <bobbens@gmail.com> |
|---|---|
| date | Wed, 06 Aug 2008 10:53:55 +0000 |
| parents | 43a0416b3707 |
| children | a0845d7f4398 |
| files | include/SDL_haptic.h |
| diffstat | 1 files changed, 7 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/include/SDL_haptic.h Wed Aug 06 10:48:35 2008 +0000 +++ b/include/SDL_haptic.h Wed Aug 06 10:53:55 2008 +0000 @@ -853,6 +853,10 @@ * * \brief Returns the number of effects a haptic device can store. * + * On some platforms this isn't fully supported, and therefore is an + * aproximation. Always check to see if your created effect was actually + * created and do not rely solely on HapticNumEffects. + * * \param haptic The haptic device to query effect max. * \return The number of effects the haptic device can store or * -1 on error. @@ -867,6 +871,9 @@ * * \brief Returns the number of effects a haptic device can play at the same time. * + * This is not supported on all platforms, but will always return a value. Added + * here for the sake of completness. + * * \param haptic The haptic device to query maximum playing effect.s * \return The number of effects the haptic device can play at the same time * or -1 on error.