encounter/SDL
1
0
Fork 0
mirror of https://github.com/encounter/SDL.git synced 2025-12-14 15:46:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

First shot at merging the wiki documentation into the headers.

Browse Source
This commit is contained in:
Ryan C. Gordon
2021-03-21 14:18:39 -04:00
parent 3c78c211d5
commit 3f40396d33
39 changed files with 7487 additions and 3073 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
include/SDL_power.h
View File

@@ -37,7 +37,7 @@ extern "C" {
#endif
/**
* \brief The basic state for the system's power supply.
* The basic state for the system's power supply.
*/
typedef enum
{
@@ -50,17 +50,28 @@ typedef enum
/**
* \brief Get the current power supply details.
* Get the current power supply details.
*
* \param secs Seconds of battery life left. You can pass a NULL here if
* you don't care. Will return -1 if we can't determine a
* value, or we're not running on a battery.
* You should never take a battery status as absolute truth. Batteries
* (especially failing batteries) are delicate hardware, and the values
* reported here are best estimates based on what that hardware reports. It's
* not uncommon for older batteries to lose stored power much faster than it
* reports, or completely drain when reporting it has 20 percent left, etc.
*
* \param pct Percentage of battery life left, between 0 and 100. You can
* pass a NULL here if you don't care. Will return -1 if we
* can't determine a value, or we're not running on a battery.
* Battery status can change at any time; if you are concerned with power
* state, you should call this function frequently, and perhaps ignore changes
* until they seem to be stable for a few seconds.
*
* \return The state of the battery (if any).
* It's possible a platform can only report battery percentage or time left
* but not both.
*
* \param secs seconds of battery life left, you can pass a NULL here if you
* don't care, will return -1 if we can't determine a value, or
* we're not running on a battery
* \param pct percentage of battery life left, between 0 and 100, you can pass
* a NULL here if you don't care, will return -1 if we can't
* determine a value, or we're not running on a battery
* \returns an SDL_PowerState enum representing the current battery state.
*/
extern DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo(int *secs, int *pct);