Skip to main content
Retrieves the arcade stick properties of the device, such as the labels of its buttons and stick directions.

Syntax

Parameters

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

Return value

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

Remarks

The GetArcadeStickInfo method copies the arcade stick properties of the device into the caller-provided structure. A device supports arcade stick input when the value returned by GetSupportedInput includes GameInputKindArcadeStick. If the device doesn’t support arcade stick input, GetArcadeStickInfo zero-initializes info and returns false. 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 arcade stick mapping; use GetExtraButtonIndexes and GetExtraAxisIndexes to locate them in the controller state of a reading. Arcade stick state is read from readings by using IGameInputReading::GetArcadeStickState. 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 arcade stick properties of a device.
In GameInput v3 and earlier, this information was available from the arcadeStickInfo 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

See also

Overview of GameInput
GameInputArcadeStickInfo
GetSupportedInput
GameInputKind
GameInputLabel
IGameInputReading::GetArcadeStickState
IGameInputDevice

Version History

Last modified on November 5, 2026