Wiki Page Content

Revision 1 as of 2010-05-16 07:45:50

Clear message

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; 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).

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


CategoryAPI, CategoryPower

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit