Parcourir la source

Add performance disclaimer in `SDL_GetPowerInfo` documentation

(cherry picked from commit 032d696021a8bba9074fd4b8b531d5ee0aa087a4)
Vittorio Romeo il y a 2 semaines
Parent
commit
5db7694f22
1 fichiers modifiés avec 3 ajouts et 0 suppressions
  1. 3 0
      include/SDL3/SDL_power.h

+ 3 - 0
include/SDL3/SDL_power.h

@@ -79,6 +79,9 @@ typedef enum SDL_PowerState
  * It's possible a platform can only report battery percentage or time left
  * but not both.
  *
+ * On some platforms, retrieving power supply details might be expensive. It
+ * is not recommended to invoke this function every frame.
+ *
  * \param seconds a pointer filled in with the seconds of battery life left,
  *                or NULL to ignore. This will be filled in with -1 if we
  *                can't determine a value or there is no battery.