GameInputRacingWheelInfo

Describes the properties of a racing wheel.

Syntax

struct GameInputRacingWheelInfo
{
    GameInputLabel menuButtonLabel;
    GameInputLabel viewButtonLabel;
    GameInputLabel previousGearButtonLabel;
    GameInputLabel nextGearButtonLabel;
    GameInputLabel dpadUpLabel;
    GameInputLabel dpadDownLabel;
    GameInputLabel dpadLeftLabel;
    GameInputLabel dpadRightLabel;
    GameInputLabel aButtonLabel;
    GameInputLabel bButtonLabel;
    GameInputLabel xButtonLabel;
    GameInputLabel yButtonLabel;
    GameInputLabel leftThumbstickButtonLabel;
    GameInputLabel rightThumbstickButtonLabel;
    GameInputLabel steeringLabel;
    GameInputLabel throttleLabel;
    GameInputLabel brakeLabel;
    GameInputLabel clutchLabel;
    GameInputLabel handbrakeLabel;
    bool           hasClutch;
    bool           hasHandbrake;
    bool           hasPatternShifter;
    int32_t        minPatternShifterGear;
    int32_t        maxPatternShifterGear;
    float          maxWheelAngle;
    uint32_t       extraButtonCount;
    uint32_t       extraAxisCount;
};

Members

menuButtonLabel
Type: GameInputLabel

Physical label for Menu button.

viewButtonLabel
Type: GameInputLabel

Physical label for View button.

previousGearButtonLabel
Type: GameInputLabel

Physical label for previous-gear selector (button).

nextGearButtonLabel
Type: GameInputLabel

Physical label for next-gear selector (button).

dpadUpLabel
Type: GameInputLabel

Physical label for D-pad up.

dpadDownLabel
Type: GameInputLabel

Physical label for D-pad down.

dpadLeftLabel
Type: GameInputLabel

Physical label for D-pad left.

dpadRightLabel
Type: GameInputLabel

Physical label for D-pad right.

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.

leftThumbstickButtonLabel
Type: GameInputLabel

Physical label for left thumbstick button.

rightThumbstickButtonLabel
Type: GameInputLabel

Physical label for right thumbstick button.

steeringLabel
Type: GameInputLabel

Physical label for the steering axis.

throttleLabel
Type: GameInputLabel

Physical label for the throttle axis.

brakeLabel
Type: GameInputLabel

Physical label for the brake axis.

clutchLabel
Type: GameInputLabel

Physical label for the clutch axis.

handbrakeLabel
Type: GameInputLabel

Physical label for the handbrake.

hasClutch
Type: bool

Indicates whether the racing wheel has a clutch input.

hasHandbrake
Type: bool

Indicates whether the racing wheel has a handbrake input.

hasPatternShifter
Type: bool

Indicates whether the racing wheel has a pattern shifter.

minPatternShifterGear
Type: int32_t

The lowest gear of the pattern shifter.

maxPatternShifterGear
Type: int32_t

The highest gear of the pattern shifter.

maxWheelAngle
Type: float

The maximum angle of the racing wheel.

extraButtonCount
Type: uint32_t

The number of device buttons that are not mapped to racing wheel buttons.

extraAxisCount
Type: uint32_t

The number of device axes that are not mapped to racing wheel axes.

Remarks

This structure is returned by the IGameInputDevice::GetRacingWheelInfo 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 steeringLabel, throttleLabel, brakeLabel, clutchLabel, and handbrakeLabel.
v3	Added 6 button labels (aButtonLabel, bButtonLabel, xButtonLabel, yButtonLabel, leftThumbstickButtonLabel, rightThumbstickButtonLabel), extraButtonCount, extraAxisCount.
v0	Introduced.

Appendix: Previous versions

v3

struct GameInputRacingWheelInfo
{
    GameInputLabel menuButtonLabel;
    GameInputLabel viewButtonLabel;
    GameInputLabel previousGearButtonLabel;
    GameInputLabel nextGearButtonLabel;
    GameInputLabel dpadUpLabel;
    GameInputLabel dpadDownLabel;
    GameInputLabel dpadLeftLabel;
    GameInputLabel dpadRightLabel;
    GameInputLabel aButtonLabel;
    GameInputLabel bButtonLabel;
    GameInputLabel xButtonLabel;
    GameInputLabel yButtonLabel;
    GameInputLabel leftThumbstickButtonLabel;
    GameInputLabel rightThumbstickButtonLabel;
    bool           hasClutch;
    bool           hasHandbrake;
    bool           hasPatternShifter;
    int32_t        minPatternShifterGear;
    int32_t        maxPatternShifterGear;
    float          maxWheelAngle;
    uint32_t       extraButtonCount;
    uint32_t       extraAxisCount;
};

v0, v1, v2

struct GameInputRacingWheelInfo
{
    GameInputLabel menuButtonLabel;
    GameInputLabel viewButtonLabel;
    GameInputLabel previousGearButtonLabel;
    GameInputLabel nextGearButtonLabel;
    GameInputLabel dpadUpLabel;
    GameInputLabel dpadDownLabel;
    GameInputLabel dpadLeftLabel;
    GameInputLabel dpadRightLabel;
    bool           hasClutch;
    bool           hasHandbrake;
    bool           hasPatternShifter;
    int32_t        minPatternShifterGear;
    int32_t        maxPatternShifterGear;
    float          maxWheelAngle;
};