> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XINPUT_BATTERY_INFORMATION

> XINPUT_BATTERY_INFORMATION

# XINPUT\_BATTERY\_INFORMATION

Describes the type and charge state of a battery.

<a id="syntaxSection" />

## Syntax

```cpp theme={null}
typedef struct XINPUT_BATTERY_INFORMATION {  
    BYTE BatteryType;  
    BYTE BatteryLevel;  
} XINPUT_BATTERY_INFORMATION  
```

<a id="membersSection" />

### Members

*BatteryType*\
Type: BYTE

The type of the battery, as one of the following values:

| Value                       | Description                                           |
| --------------------------- | ----------------------------------------------------- |
| BATTERY\_TYPE\_DISCONNECTED | The device is not connected.                          |
| BATTERY\_TYPE\_WIRED        | The device is wired and does not have a battery.      |
| BATTERY\_TYPE\_ALKALINE     | The device has an alkaline battery.                   |
| BATTERY\_TYPE\_NIMH         | The device has a nickel-metal hydride (NiMH) battery. |
| BATTERY\_TYPE\_UNKNOWN      | The device has an unknown battery type.               |

*BatteryLevel*\
Type: BYTE

The charge state of the battery, compared to its full-charge capacity, as one of the following values:

| Value                  | Description                     |
| ---------------------- | ------------------------------- |
| BATTERY\_LEVEL\_EMPTY  | Charge is between zero and 10%. |
| BATTERY\_LEVEL\_LOW    | Charge is between 10% and 40%.  |
| BATTERY\_LEVEL\_MEDIUM | Charge is between 40% and 70%.  |
| BATTERY\_LEVEL\_FULL   | Charge is between 70% and 100%. |

<a id="remarksSection" />

## Remarks

The *BatteryLevel* value is valid only for a device that has a known battery type.

This structure is used by the [XInputGetBatteryInformation](/reference/input/xinputongameinput/functions/xinputgetbatteryinformation) function.

For more information, see [The XInputOnGameInput wrapper](/build/core-features/common/input/porting/input-porting-xinput#xinputWrapperSection).

<a id="requirementsSection" />

## Requirements

**Header:** XInputOnGameInput.h

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

<a id="seealsoSection" />

## See also

[Porting from XInput to GameInput](/build/core-features/common/input/porting/input-porting-xinput)\
[XInputOnGameInput](/reference/input/xinputongameinput/xinputongameinput_members)


## Related topics

- [XInputGetBatteryInformation](/reference/input/xinputongameinput/functions/xinputgetbatteryinformation.md)
- [XInputOnGameInput](/reference/input/xinputongameinput/xinputongameinput_members.md)
- [XINPUT_STATE](/reference/input/xinputongameinput/structs/xinput_state.md)
- [XINPUT_VIBRATION](/reference/input/xinputongameinput/structs/xinput_vibration.md)
- [IGameInputDevice::GetBatteryState](/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getbatterystate.md)
