Share via


IGameInputMapper::GetGamepadButtonMapping

Syntax

bool GetGamepadButtonMappingInfo(
    GameInputGamepadButtons buttonElement,
    GameInputButtonMapping* mapping
);

Parameters

buttonElement   _In_
Type: GameInputGamepadButtons

The specific gamepad button whose mapping is being queried.

mapping   _Out_
Type: GameInputButtonMapping

The mapping information of how the button is mapped from the controller axes, buttons or switches.

Return value

Type: bool

If the mapping was successfully retrieved. This value is false if the device does not support the GameInputKindGamepad input kind or if the specified button element is not supported by the device.

Requirements

Header: GameInput.h

Library: gameinput.lib

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

See also

Input API Overview
IGameInputMapper