GameInputFlightStickInfo

Describes the properties of a flight stick.

Syntax

struct GameInputFlightStickInfo
{
    GameInputLabel menuButtonLabel;
    GameInputLabel viewButtonLabel;
    GameInputLabel firePrimaryButtonLabel;
    GameInputLabel fireSecondaryButtonLabel;
    GameInputLabel hatSwitchUpLabel;
    GameInputLabel hatSwitchDownLabel;
    GameInputLabel hatSwitchLeftLabel;
    GameInputLabel hatSwitchRightLabel;
    GameInputLabel aButtonLabel;
    GameInputLabel bButtonLabel;
    GameInputLabel xButtonLabel;
    GameInputLabel yButtonLabel;
    GameInputLabel leftShoulderButtonLabel;
    GameInputLabel rightShoulderButtonLabel;
    GameInputLabel rollLabel;
    GameInputLabel pitchLabel;
    GameInputLabel yawLabel;
    GameInputLabel throttleLabel;
    uint32_t       extraButtonCount;
    uint32_t       extraAxisCount;
};

Members

menuButtonLabel
Type: GameInputLabel

Physical label for Menu button.

viewButtonLabel
Type: GameInputLabel

Physical label for View button.

firePrimaryButtonLabel
Type: GameInputLabel

Physical label for primary fire button.

fireSecondaryButtonLabel
Type: GameInputLabel

Physical label for secondary fire button.

hatSwitchUpLabel
Type: GameInputLabel

Physical label for up input from hat switch.

hatSwitchDownLabel
Type: GameInputLabel

Physical label for down input from hat switch.

hatSwitchLeftLabel
Type: GameInputLabel

Physical label for left input from hat switch.

hatSwitchRightLabel
Type: GameInputLabel

Physical label for right input from hat switch.

aButtonLabel
Type: GameInputLabel

Physical label for A button.

bButtonLabel
Type: GameInputLabel

Physical label for B button.

xButtonLabel
Type: GameInputLabel

Physical label for X button.

yButtonLabel
Type: GameInputLabel

Physical label for Y button.

leftShoulderButtonLabel
Type: GameInputLabel

Physical label for left shoulder button.

rightShoulderButtonLabel
Type: GameInputLabel

Physical label for right shoulder button.

rollLabel
Type: GameInputLabel

Physical label for the roll axis.

pitchLabel
Type: GameInputLabel

Physical label for the pitch axis.

yawLabel
Type: GameInputLabel

Physical label for the yaw axis.

throttleLabel
Type: GameInputLabel

Physical label for the throttle axis.

extraButtonCount
Type: uint32_t

The number of device buttons that are not mapped to flight stick buttons.

extraAxisCount
Type: uint32_t

The number of device axes that are not mapped to flight stick axes.

Remarks

This structure is returned by the IGameInputDevice::GetFlightStickInfo method. In GameInput v3 and earlier, it was a member of the GameInputDeviceInfo structure returned by IGameInputDevice::GetDeviceInfo.

For more information, see GameInput devices.

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
v4	Added axis labels rollLabel, pitchLabel, yawLabel, and throttleLabel.
v3	Removed hatSwitchKind. Added 4 hat direction button labels (hatSwitchUpLabel, hatSwitchDownLabel, hatSwitchLeftLabel, hatSwitchRightLabel), 4 face button labels (aButtonLabel, bButtonLabel, xButtonLabel, yButtonLabel), extraButtonCount, extraAxisCount.
v0	Introduced.

Appendix: Previous versions

v3

struct GameInputFlightStickInfo
{
    GameInputLabel menuButtonLabel;
    GameInputLabel viewButtonLabel;
    GameInputLabel firePrimaryButtonLabel;
    GameInputLabel fireSecondaryButtonLabel;
    GameInputLabel hatSwitchUpLabel;
    GameInputLabel hatSwitchDownLabel;
    GameInputLabel hatSwitchLeftLabel;
    GameInputLabel hatSwitchRightLabel;
    GameInputLabel aButtonLabel;
    GameInputLabel bButtonLabel;
    GameInputLabel xButtonLabel;
    GameInputLabel yButtonLabel;
    GameInputLabel leftShoulderButtonLabel;
    GameInputLabel rightShoulderButtonLabel;
    uint32_t       extraButtonCount;
    uint32_t       extraAxisCount;
};

v0, v1, v2

struct GameInputFlightStickInfo
{
    GameInputLabel      menuButtonLabel;
    GameInputLabel      viewButtonLabel;
    GameInputLabel      firePrimaryButtonLabel;
    GameInputLabel      fireSecondaryButtonLabel;
    GameInputSwitchKind hatSwitchKind;
};