> ## 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.

# GameInputGamepadInfo

> Reference for the GameInputGamepadInfo struct: describes gamepad layout, per-button physical labels, extra button count, and extra axis count.

# GameInputGamepadInfo

Describes the properties of a gamepad.

<a id="syntaxSection" />

## Syntax

```cpp theme={null}
struct GameInputGamepadInfo
{
    GameInputGamepadButtons supportedLayout;
    GameInputLabel          menuButtonLabel;
    GameInputLabel          viewButtonLabel;
    GameInputLabel          aButtonLabel;
    GameInputLabel          bButtonLabel;
    GameInputLabel          cButtonLabel;
    GameInputLabel          xButtonLabel;
    GameInputLabel          yButtonLabel;
    GameInputLabel          zButtonLabel;
    GameInputLabel          dpadUpLabel;
    GameInputLabel          dpadDownLabel;
    GameInputLabel          dpadLeftLabel;
    GameInputLabel          dpadRightLabel;
    GameInputLabel          leftShoulderButtonLabel;
    GameInputLabel          rightShoulderButtonLabel;
    GameInputLabel          leftThumbstickButtonLabel;
    GameInputLabel          rightThumbstickButtonLabel;
    uint32_t                extraButtonCount;
    uint32_t                extraAxisCount;
};
```

<a id="membersSection" />

### Members

*supportedLayout*<br />
Type: [GameInputGamepadButtons](/reference/input/gameinput/enums/gameinputgamepadbuttons)

Describes the layout of the gamepad. Since axes have button translations, then these can be used to determine which axes are present on the gamepad.

*menuButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for Menu button.

*viewButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for View button.

*aButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for **A** button.

*bButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for **B** button.

*cButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for **C** button.

*xButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for **X** button.

*yButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for **Y** button.

*zButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for **Z** button.

*dpadUpLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for D-pad up.

*dpadDownLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for D-pad down.

*dpadLeftLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for D-pad left.

*dpadRightLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for D-Pad right.

*leftShoulderButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for left shoulder button.

*rightShoulderButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for right shoulder button.

*leftThumbstickButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for left thumbstick.

*rightThumbstickButtonLabel*<br />
Type: [GameInputLabel](/reference/input/gameinput/enums/gameinputlabel)

Physical label for right thumbstick.

*extraButtonCount*<br />
Type: uint32\_t

The number of device buttons that are not mapped to gamepad buttons.

*extraAxisCount*<br />
Type: uint32\_t

The number of device axes that are not mapped to gamepad axes.

<a id="remarksSection" />

## Remarks

This structure is used in the [GameInputDeviceInfo](/reference/input/gameinput/structs/gameinputdeviceinfo) structure.

`GameInputDeviceInfo` is used by the [IGameInputDevice::GetDeviceInfo](/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getdeviceinfo) method.

For more information, see [GameInput devices](/build/core-features/common/input/overviews/input-devices).

### Gamepad Layout

GameInput supports a range of form factors for gamepads instead of limiting support to a single standard layout. This is exposed through the `supportedLayout` member of this structure as a bitfield of type [GameInputGamepadButtons](/reference/input/gameinput/enums/gameinputgamepadbuttons). Axes are also present in this enumeration through the axis-to-button translations such as `GameInputGamepadLeftTriggerButton`. For more information on these translations, see [GameInputGamepadButtons](/reference/input/gameinput/enums/gameinputgamepadbuttons#remarks).

There is no minimum required layout for a gamepad and it may have any combination of the supported axes and buttons. Any buttons or axes not supported are expected to be left and accessed as extra axes or buttons.

We have defined some common groupings of gamepad elements and common layouts as constants. These can be used to quickly identify a common layout, filter for specific inputs, or create custom layouts. For more information, see [GameInputGamepadButtons](/reference/input/gameinput/enums/gameinputgamepadbuttons#constantsSection).

Since the expected range of supported layouts and form factors is limitless, there is a small set of considerations and behaviors that we expect for mappings and gamepad users to follow:

* For elements of which there are two, such as thumbsticks, shoulder or triggers, if there is one present in the center, then the default should be for it be the left element. If it is positioned to the left or right of the device, then it should be mapped accordingly.

* In order to prevent ambiguity due to different glyphs, face buttons are expected to be mapped and read according to their physical position and regardless of its glyph as following:

<img src="https://mintcdn.com/microsoft-4404708b/5IpvKlT-jmAaVkeY/images/input-gamepad-facebutton-layouts.png?fit=max&auto=format&n=5IpvKlT-jmAaVkeY&q=85&s=37ae6f7821291d3118275f019d27685d" alt="Gamepad face button layout guidelines" height="600" data-path="images/input-gamepad-facebutton-layouts.png" />

The following code example demonstrates how to determine whether a gamepad supports a layout or a specific input or module.

```cpp theme={null}
bool IsStandardLayout(const GameInputGamepadInfo& gamepadInfo) noexcept
{
    // Supports the standard layout and no more
    return (gamepadInfo.supportedLayout & GameInputGamepadLayoutStandard) == GameInputGamepadLayoutStandard;
}

bool IsDpadSupported(const GameInputGamepadInfo& gamepadInfo) noexcept
{
    // Supports the D-pad module and more
    return gamepadInfo.supportedLayout & GameInputGamepadModuleDpad;
}

bool IsXButtonSupported(const GameInputGamepadInfo& gamepadInfo) noexcept
{
    return gamepadInfo.supportedLayout & GameInputGamepadX;
}
```

The following code example demonstrates how to create a custom layout and determine if the gamepad supports it.

```cpp theme={null}
bool IsCustomLayoutSupported(const GameInputGamepadInfo& gamepadInfo) noexcept
{
    static const GameInputGamepadButtons customLayout =
        GameInputGamepadA |
        GameInputGamepadB |
        GameInputGamepadC |
        GameInputGamepadX |
        GameInputGamepadY |
        GameInputGamepadZ |
        GameInputGamepadModuleShoulders |
        GameInputGamepadModuleDpad;

    return (gamepadInfo.supportedLayout & customLayout) == GameInputGamepadLayoutCustom;
}
```

<a id="requirementsSection" />

## Requirements

**Header:** GameInput.h

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

<a id="seealsoSection" />

## See also

[Overview of GameInput](/build/core-features/common/input/overviews/input-overview)\
[GameInput](/reference/input/gameinput/gameinput_members)

## Version History

| Version | Changes                                                                                                                              |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **v3**  | **Added** `supportedLayout` (GameInputGamepadButtons bitmask), `cButtonLabel`, `zButtonLabel`, `extraButtonCount`, `extraAxisCount`. |
| **v0**  | Introduced.                                                                                                                          |

## Appendix: Previous versions

### v0, v1, v2

```cpp theme={null}
struct GameInputGamepadInfo
{
    GameInputLabel menuButtonLabel;
    GameInputLabel viewButtonLabel;
    GameInputLabel aButtonLabel;
    GameInputLabel bButtonLabel;
    GameInputLabel xButtonLabel;
    GameInputLabel yButtonLabel;
    GameInputLabel dpadUpLabel;
    GameInputLabel dpadDownLabel;
    GameInputLabel dpadLeftLabel;
    GameInputLabel dpadRightLabel;
    GameInputLabel leftShoulderButtonLabel;
    GameInputLabel rightShoulderButtonLabel;
    GameInputLabel leftThumbstickButtonLabel;
    GameInputLabel rightThumbstickButtonLabel;
};
```