Power Management Status

SDL power management routines. More...

Functions
PowerState	SDL::GetPowerInfo (int *seconds, int *percent)
	Get the current power supply details.

Power States
using	SDL::PowerState = SDL_PowerState
	The basic state for the system's power supply.
constexpr PowerState	SDL::POWERSTATE_ERROR
	error determining power status
constexpr PowerState	SDL::POWERSTATE_UNKNOWN
	cannot determine power status
constexpr PowerState	SDL::POWERSTATE_ON_BATTERY
	Not plugged in, running on the battery.
constexpr PowerState	SDL::POWERSTATE_NO_BATTERY
	Plugged in, no battery available.
constexpr PowerState	SDL::POWERSTATE_CHARGING
	Plugged in, charging battery.
constexpr PowerState	SDL::POWERSTATE_CHARGED
	Plugged in, battery charged.

Detailed Description

There is a single function in this category: GetPowerInfo().

This function is useful for games on the go. This allows an app to know if it's running on a draining battery, which can be useful if the app wants to reduce processing, or perhaps framerate, to extend the duration of the battery's charge. Perhaps the app just wants to show a battery meter when fullscreen, or alert the user when the power is getting extremely low, so they can save their game.

Typedef Documentation

PowerState

using SDL::PowerState = typedef SDL_PowerState

These are results returned by GetPowerInfo().

Since

This enum is available since SDL 3.2.0.

Function Documentation

GetPowerInfo()

PowerState SDL::GetPowerInfo ( int *  seconds, int *  percent  )

inline

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.

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.

It's possible a platform can only report battery percentage or time left but not both.

On some platforms, retrieving power supply details might be expensive. If you want to display continuous status you could call this function every minute or so.

Parameters

seconds	a pointer filled in with the seconds of battery life left, or nullptr to ignore. This will be filled in with -1 if we can't determine a value or there is no battery.
percent	a pointer filled in with the percentage of battery life left, between 0 and 100, or nullptr to ignore. This will be filled in with -1 we can't determine a value or there is no battery.

Returns

the current battery state or POWERSTATE_ERROR on failure; call GetError() for more information.

Since

This function is available since SDL 3.2.0.

Variable Documentation

POWERSTATE_CHARGED

constexpr PowerState SDL::POWERSTATE_CHARGED

constexpr

Initial value:

=
  SDL_POWERSTATE_CHARGED

POWERSTATE_CHARGING

constexpr PowerState SDL::POWERSTATE_CHARGING

constexpr

Initial value:

=
  SDL_POWERSTATE_CHARGING

POWERSTATE_ERROR

constexpr PowerState SDL::POWERSTATE_ERROR

constexpr

Initial value:

=
  SDL_POWERSTATE_ERROR

POWERSTATE_NO_BATTERY

constexpr PowerState SDL::POWERSTATE_NO_BATTERY

constexpr

Initial value:

=
  SDL_POWERSTATE_NO_BATTERY

POWERSTATE_ON_BATTERY

constexpr PowerState SDL::POWERSTATE_ON_BATTERY

constexpr

Initial value:

=
  SDL_POWERSTATE_ON_BATTERY

POWERSTATE_UNKNOWN

constexpr PowerState SDL::POWERSTATE_UNKNOWN

constexpr

Initial value:

=
  SDL_POWERSTATE_UNKNOWN