|
Size: 1577
Comment: added include
|
Size: 1652
Comment: minor change
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 25: | Line 25: |
| Returns the state of the battery (if any). Return values may be any of the following: | Returns the state of the battery (if any). Return values may be any of the following (see [[SDL_PowerState]] for more info): |
| Line 29: | Line 29: |
| <<Color2(green,Below is text that was listed as param in the header but seems more relevant here or in Remarks.)>> | <<Color2(green,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.)>> |
DRAFT |
SDL_GetPowerInfo
Use this function to get the current power supply details.
Contents
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; pass a NULL if irrelevant/unimportant |
pct |
percentage of battery life left, between 0 and 100; pass a NULL if irrelevant/unimportant |
Return Value
Returns the state of the battery (if any). Return values may be any of the following (see SDL_PowerState for more info):
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 |
green
Both parameters will returns -1 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
