Mirrors_Framework/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-05-31 22:42:52 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

include: Add category documentation to SDL_power.h.

Browse Source 
Reference Issue #11847.
This commit is contained in:
Ryan C. Gordon
2025-01-19 12:11:16 -05:00
parent 43b54b3d72
commit 0851322fb1
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/SDL3/SDL_power.h
+9
View File
@@ -26,6 +26,15 @@
* # CategoryPower * # CategoryPower
* *
* SDL power management routines. * SDL power management routines.
*
* There is a single function in this category: SDL_GetPowerInfo().
*
* This function is useful for games on the go. This allows an app
* to know if it's running on a draining battery, which can be useful if
* the app wants to reduce processing, or perhaps framerate, to extend the
* duration of the battery's charge. Perhaps the app just wants to show
* a battery meter when fullscreen, or alert the user when the power is
* getting extremely low, so they can save their game.
*/ */
#include <SDL3/SDL_stdinc.h> #include <SDL3/SDL_stdinc.h>