mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-06 03:18:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add performance disclaimer in SDL_GetPowerInfo documentation

Browse Source
This commit is contained in:
Vittorio Romeo
2025-03-31 16:39:05 +02:00
committed by Sam Lantinga
parent 0d04e9ea6a
commit 032d696021
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
include/SDL3/SDL_power.h
View File

@@ -79,6 +79,9 @@ typedef enum SDL_PowerState
* It's possible a platform can only report battery percentage or time left * It's possible a platform can only report battery percentage or time left
* but not both. * 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, * \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 * or NULL to ignore. This will be filled in with -1 if we
* can't determine a value or there is no battery. * can't determine a value or there is no battery.