SDL Library
SDL_power.h File Reference
Header for the SDL power management routines. More...
Go to the source code of this file.
Enumerations | |
enum | SDL_PowerState { SDL_POWERSTATE_UNKNOWN, SDL_POWERSTATE_ON_BATTERY, SDL_POWERSTATE_NO_BATTERY, SDL_POWERSTATE_CHARGING, SDL_POWERSTATE_CHARGED } |
The basic state for the system's power supply. More... | |
Functions | |
DECLSPEC SDL_PowerState SDLCALL | SDL_GetPowerInfo (int *secs, int *pct) |
Get the current power supply details. |
Detailed Description
Header for the SDL power management routines.
Definition in file SDL_power.h.
Enumeration Type Documentation
enum SDL_PowerState |
The basic state for the system's power supply.
- Enumerator:
Definition at line 42 of file SDL_power.h.
Function Documentation
DECLSPEC SDL_PowerState SDLCALL SDL_GetPowerInfo | ( | int * | secs, |
int * | pct | ||
) |
Get the current power supply details.
- Parameters:
-
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. 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:
- The state of the battery (if any).
Generated on Tue Jul 12 2022 15:10:21 by 1.7.2