GameInputBatteryStatus

Enumerates battery states for an input device.

Syntax

typedef enum GameInputBatteryStatus  
{  
    GameInputBatteryUnknown = -1,  
    GameInputBatteryNotPresent = 0,  
    GameInputBatteryDischarging = 1,  
    GameInputBatteryIdle = 2,  
    GameInputBatteryCharging = 3  
} GameInputBatteryStatus  

Constants

Constant Description
GameInputBatteryUnknown The state of the battery is unknown.
GameInputBatteryNotPresent The device does not have a battery.
GameInputBatteryDischarging The battery is discharging.
GameInputBatteryIdle The battery is not charging.
GameInputBatteryCharging The battery is charging.

Remarks

This enumeration is used in the GameInputBatteryState structure. The structure is used by the IGameInputDevice::GetBatteryState method.

For more information, see GameInput devices.

Requirements

Header: GameInput.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Overview of GameInput
GameInput