Share via


GetExtraButtonCount

Gets the number of extra buttons, or non-supported buttons, present in the device for a given input kind.

Syntax

HRESULT GetExtraButtonCount(
    GameInputKind inputKind,
    uint32_t* extraButtonCount
);

Parameters

inputKind   _In_
Type: GameInputKind

The input kind whose extra button count is being requested.

extraButtonCount   _Out_
Type: uint32_t*

The number of extra buttons, or non-supported buttons, present in the device for the specified input kind.

Return value

Type: HRESULT

Function result.

Remarks

Extra buttons are controller buttons that exist on the physical device but are not part of the standard mapping for the specified input kind. This method is useful for applications that want to access device-specific buttons that go beyond the standard input mapping.

The obtained count is expected to be used with the GetExtraButtonIndexes method to retrieve the specific indexes of these extra buttons and to buffer the correct space to store the button indexes provided by that method.

Requirements

Header: GameInput.h

Library: gameinput.lib

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

See also

GameInputKind
GetExtraButtonIndexes
GetExtraAxisCount
IGameInputDevice

Version History

Version Changes
v3 Introduced.