Skip to content

Commit

Permalink
include: Add category documentation to SDL_power.h.
Browse files Browse the repository at this point in the history
Reference Issue #11847.
  • Loading branch information
icculus committed Jan 19, 2025
1 parent 43b54b3 commit 0851322
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions include/SDL3/SDL_power.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@
* # CategoryPower
*
* 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>
Expand Down

0 comments on commit 0851322

Please sign in to comment.