IGameInputDevice::GetGamepadInfo

Retrieves the gamepad properties of the device, such as its supported button layout and the labels of its controls.

Syntax

bool GetGamepadInfo(
    GameInputGamepadInfo* info
);

Parameters

info _Out_
Type: GameInputGamepadInfo* Pointer to a GameInputGamepadInfo structure that receives the gamepad properties of the device. If the device doesn’t support gamepad input, every member of the structure is set to zero.

Return value

Type: bool true if the device supports gamepad input and info was filled in; otherwise, false.

Remarks

The GetGamepadInfo method copies the gamepad properties of the device into the caller-provided structure. A device supports gamepad input when the value returned by GetSupportedInput includes GameInputKindGamepad. If the device doesn’t support gamepad input, GetGamepadInfo zero-initializes info and returns false. The supportedLayout member is a combination of GameInputGamepadButtons flags that identifies which standard gamepad buttons the device has. The label members describe the markings printed on the corresponding controls, as GameInputLabel values, so you can show matching prompts in your UI. The extraButtonCount and extraAxisCount members report how many controller buttons and axes the device has beyond the standard gamepad mapping; use GetExtraButtonIndexes and GetExtraAxisIndexes to locate them in the controller state of a reading. Gamepad state is read from readings by using IGameInputReading::GetGamepadState. The properties returned by this method are fixed for the lifetime of the device, so you can query them once (for example, when the device connects) and cache the result. The following example shows how to query the gamepad properties of a device.

GameInputGamepadInfo info;
if (device->GetGamepadInfo(&info))
{
    if (info.aButtonLabel == GameInputLabelXboxA)
    {
        // Show XBOX-style button prompts.
    }
}

In GameInput v3 and earlier, this information was available from the gamepadInfo member of the GameInputDeviceInfo structure returned by IGameInputDevice::GetDeviceInfo.

Requirements

Header: GameInput.h Library: gameinput.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Version History

Version	Changes
v4	Introduced.

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

​Version History

Syntax

Parameters

Return value

Remarks

Requirements

See also

Version History