Updating documentation about NumEffects and NumPlaying.

libsdl-org · Aug 6, 2008 · 0608cb9 · 0608cb9
1 parent ec8ccd3
commit 0608cb9
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/include/SDL_haptic.h b/include/SDL_haptic.h
@@ -853,6 +853,10 @@ extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic);
  *
  * \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 @@ extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic);
  *
  * \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.