Mercurial > sdl-ios-xcode

comparison include/SDL_haptic.h @ 2630:776f7f800131 gsoc2008_force_feedback

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updating documentation about NumEffects and NumPlaying.
author Edgar Simo <bobbens@gmail.com>
date Wed, 06 Aug 2008 10:53:55 +0000
parents 446054caaa81
children 269ba4f28d0e
comparison
equal deleted inserted replaced
2629:43a0416b3707 2630:776f7f800131
851 /** 851 /**
852 * \fn int SDL_HapticNumEffects(SDL_Haptic * haptic) 852 * \fn int SDL_HapticNumEffects(SDL_Haptic * haptic)
853 * 853 *
854 * \brief Returns the number of effects a haptic device can store. 854 * \brief Returns the number of effects a haptic device can store.
855 * 855 *
856 * On some platforms this isn't fully supported, and therefore is an
857 * aproximation. Always check to see if your created effect was actually
858 * created and do not rely solely on HapticNumEffects.
859 *
856 * \param haptic The haptic device to query effect max. 860 * \param haptic The haptic device to query effect max.
857 * \return The number of effects the haptic device can store or 861 * \return The number of effects the haptic device can store or
858 * -1 on error. 862 * -1 on error.
859 * 863 *
860 * \sa SDL_HapticNumEffectsPlaying 864 * \sa SDL_HapticNumEffectsPlaying
864 868
865 /** 869 /**
866 * \fn int SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic) 870 * \fn int SDL_HapticNumEffectsPlaying(SDL_Haptic * haptic)
867 * 871 *
868 * \brief Returns the number of effects a haptic device can play at the same time. 872 * \brief Returns the number of effects a haptic device can play at the same time.
873 *
874 * This is not supported on all platforms, but will always return a value. Added
875 * here for the sake of completness.
869 * 876 *
870 * \param haptic The haptic device to query maximum playing effect.s 877 * \param haptic The haptic device to query maximum playing effect.s
871 * \return The number of effects the haptic device can play at the same time 878 * \return The number of effects the haptic device can play at the same time
872 * or -1 on error. 879 * or -1 on error.
873 * 880 *