Skip to main content

IGameInputReading::GetGamepadState

Retrieve a view of the input reading that describes the state of a gamepad.

Syntax

Parameters

state   _Out_
Type: GameInputGamepadState*
Interpretation of the input as a gamepad.

Return value

Type: bool Returns true on successful interpretation of a gamepad. Returns false when attempting to read an input that is not recognized as a gamepad.

Remarks

Call the IGameInputReading::GetInputKind method to see which Get*State functions will return a valid interpretation for some IGameInputReading. Each Get*State function has a corresponding entry in the IGameInputReading::GetInputKind enum. If you attempt to call a Get*State function where the corresponding IGameInputReading::GetInputKind flag is not set, the function will return with default at rest values as well as a false return value. The following C++ sample demonstrates how to read the gamepad state.

Requirements

Input API Overview
IGameInputReading
IGameInputReading::GetInputKind

Version History

Last modified on August 4, 2026