GameInputControllerSwitchInfo

Describes a switch on an input device.

Syntax

struct GameInputControllerSwitchInfo
{
    GameInputLabel      labels[GAMEINPUT_MAX_SWITCH_STATES];
    GameInputSwitchKind kind;
};

Members

labels
Type: GameInputLabel

The labels for the switch states.

kind
Type: GameInputSwitchKind

The type of the switch.

Remarks

This structure is used in the GameInputControllerInfo structure. GameInputControllerInfo is used by the GameInputDeviceInfo structure to describe the properties of a controller input device.

Requirements

Header: GameInput.h

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

See also

Overview of GameInput
GameInput

Version History

Version	Changes
v3	Removed mappedInputKinds. Replaced singular label with array labels[GAMEINPUT_MAX_SWITCH_STATES].
v1	Removed positionLabels[9], all legacy/raw HID and DInput fields (legacyDInputIndex, legacyHidIndex, rawReportIndex, raw report pointers).
v0	Introduced.

Appendix: Previous versions

v1, v2

struct GameInputControllerSwitchInfo
{
    GameInputKind       mappedInputKinds;
    GameInputLabel      label;
    GameInputSwitchKind kind;
};

v0

struct GameInputControllerSwitchInfo
{
    GameInputKind       mappedInputKinds;
    GameInputLabel      label;
    GameInputLabel      positionLabels[9];
    GameInputSwitchKind kind;
    uint8_t             legacyDInputIndex;
    uint8_t             legacyHidIndex;
    uint16_t            rawReportIndex;
};