DRAFT |
SDL_GetPowerInfo
Use this function to get the current power supply details.
Syntax
SDL_PowerState SDL_GetPowerInfo(int* secs,
int* pct)
Function 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 |
alternative text:
secs |
seconds of battery life left; NULL if irrelevant/unimportant |
pct |
percent of battery life left (0 - 100); NULL if irrelevant/unimportant |
Return Value
Returns the state of the battery, if any. Return values may be any of the following:
SDL_POWERSTATE_UNKNOWN |
cannot determine power status |
SDL_POWERSTATE_ON_BATTERY |
not plugged in, running on the battery |
SDL_POWERSTATE_NO_BATTERY |
plugged in, no battery available |
SDL_POWERSTATE_CHARGING |
plugged in, charging battery |
SDL_POWERSTATE_CHARGED |
plugged in, battery charged |
See SDL_PowerState for more info.
Above is an include from the enum. Below is text that was listed as param in the header but seems more relevant here or in Remarks. Both parameters will returns -1 a negative error code if a value can't be determined, or if not running on a battery.
Code Examples
You can add your code example here
Remarks
You can add useful comments here