Qt Documentation (Technology Preview) | Qt Gamepad | C++ Classes | QGamepad

Qt 5.9.4 Reference Documentation

# QGamepad Class

A gamepad device connected to a system More...

Header: | #include <QGamepad>
qmake: | QT += gamepad
Inherits: | QObject

- List of all members, including inherited members

## Properties

axisLeftX : const double axisLeftY : const double axisRightX : const double axisRightY : const double buttonL1 : const bool buttonL2 : const double buttonL3 : const bool buttonR1 : const bool buttonR2 : const double buttonR3 : const bool buttonA : const bool buttonB : const bool buttonCenter : const bool | buttonDown : const bool buttonGuide : const bool buttonLeft : const bool buttonRight : const bool buttonSelect : const bool buttonStart : const bool buttonUp : const bool buttonX : const bool buttonY : const bool connected : const bool deviceId : int name : const QString

- 1 property inherited from QObject

## Public Functions

| QGamepad(int deviceId = 0, QObject *parent = nullptr)
| ~QGamepad()
double | axisLeftX() const
double | axisLeftY() const
double | axisRightX() const
double | axisRightY() const
bool | buttonL1() const
double | buttonL2() const
bool | buttonL3() const
bool | buttonR1() const
double | buttonR2() const
bool | buttonR3() const
bool | buttonA() const
bool | buttonB() const
bool | buttonCenter() const
bool | buttonDown() const
bool | buttonGuide() const
bool | buttonLeft() const
bool | buttonRight() const
bool | buttonSelect() const
bool | buttonStart() const
bool | buttonUp() const
bool | buttonX() const
bool | buttonY() const
int | deviceId() const
bool | isConnected() const
QString | name() const

- 32 public functions inherited from QObject

## Public Slots

void | setDeviceId(int number)

- 1 public slot inherited from QObject

## Signals

void | axisLeftXChanged(double value)
void | axisLeftYChanged(double value)
void | axisRightXChanged(double value)
void | axisRightYChanged(double value)
void | buttonAChanged(bool value)
void | buttonBChanged(bool value)
void | buttonCenterChanged(bool value)
void | buttonDownChanged(bool value)
void | buttonGuideChanged(bool value)
void | buttonL1Changed(bool value)
void | buttonL2Changed(double value)
void | buttonL3Changed(bool value)
void | buttonLeftChanged(bool value)
void | buttonR1Changed(bool value)
void | buttonR2Changed(double value)
void | buttonR3Changed(bool value)
void | buttonRightChanged(bool value)
void | buttonSelectChanged(bool value)
void | buttonStartChanged(bool value)
void | buttonUpChanged(bool value)
void | buttonXChanged(bool value)
void | buttonYChanged(bool value)
void | connectedChanged(bool value)
void | deviceIdChanged(int value)
void | nameChanged(QString value)

- 2 signals inherited from QObject

### Additional Inherited Members

- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject

## Detailed Description

A gamepad device connected to a system

QGamepad is used to access the current state of gamepad hardware connected to a system.

## Property Documentation

### axisLeftX : const double

This read-only property holds the value of the left thumbstick's X axis. The axis values range from -1.0 to 1.0.

Access functions:

double | axisLeftX() const

Notifier signal:

void | axisLeftXChanged(double value)

### axisLeftY : const double

This read-only property holds the value of the left thumbstick's Y axis. The axis values range from -1.0 to 1.0.

Access functions:

double | axisLeftY() const

Notifier signal:

void | axisLeftYChanged(double value)

### axisRightX : const double

This read-only property holds the value of the right thumbstick's X axis. The axis values range from -1.0 to 1.0.

Access functions:

double | axisRightX() const

Notifier signal:

void | axisRightXChanged(double value)

### axisRightY : const double

This read-only property holds the value of the right thumbstick's Y axis. The axis values range from -1.0 to 1.0.

Access functions:

double | axisRightY() const

Notifier signal:

void | axisRightYChanged(double value)

### buttonL1 : const bool

This read-only property holds the state of the left shoulder button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonL1() const

Notifier signal:

void | buttonL1Changed(bool value)

### buttonL2 : const double

This read-only property holds the value of the left trigger button. This trigger value ranges from 0.0 when not pressed to 1.0 when pressed completely.

Access functions:

double | buttonL2() const

Notifier signal:

void | buttonL2Changed(double value)

### buttonL3 : const bool

This read-only property holds the state of the left stick button. The value is `true` when pressed, and `false` when not pressed. This button is usually triggered by pressing the left joystick itself.

Access functions:

bool | buttonL3() const

Notifier signal:

void | buttonL3Changed(bool value)

### buttonR1 : const bool

This read-only property holds the state of the right shoulder button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonR1() const

Notifier signal:

void | buttonR1Changed(bool value)

### buttonR2 : const double

This read-only property holds the value of the right trigger button. This trigger value ranges from 0.0 when not pressed to 1.0 when pressed completely.

Access functions:

double | buttonR2() const

Notifier signal:

void | buttonR2Changed(double value)

### buttonR3 : const bool

This read-only property holds the state of the right stick button. The value is `true` when pressed, and `false` when not pressed. This button is usually triggered by pressing the right joystick itself.

Access functions:

bool | buttonR3() const

Notifier signal:

void | buttonR3Changed(bool value)

### buttonA : const bool

This read-only property holds the state of the A button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonA() const

Notifier signal:

void | buttonAChanged(bool value)

### buttonB : const bool

This read-only property holds the state of the B button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonB() const

Notifier signal:

void | buttonBChanged(bool value)

See also QGamepadManager::connectedGamepads().

### buttonCenter : const bool

This read-only property holds the state of the center button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonCenter() const

Notifier signal:

void | buttonCenterChanged(bool value)

### buttonDown : const bool

This read-only property holds the state of the direction pad down button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonDown() const

Notifier signal:

void | buttonDownChanged(bool value)

### buttonGuide : const bool

This read-only property holds the state of the guide button. The value is `true` when pressed, and `false` when not pressed. This button is typically the one in the center of the gamepad with a logo. Some gamepads will not have a guide button.

Access functions:

bool | buttonGuide() const

Notifier signal:

void | buttonGuideChanged(bool value)

### buttonLeft : const bool

This read-only property holds the state of the direction pad left button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonLeft() const

Notifier signal:

void | buttonLeftChanged(bool value)

### buttonRight : const bool

This read-only property holds the state of the direction pad right button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonRight() const

Notifier signal:

void | buttonRightChanged(bool value)

### buttonSelect : const bool

This read-only property holds the state of the Select button. The value is `true` when pressed, and `false` when not pressed. This button can sometimes be labeled as the Back button on some gamepads.

Access functions:

bool | buttonSelect() const

Notifier signal:

void | buttonSelectChanged(bool value)

### buttonStart : const bool

This read-only property holds the state of the Start button. The value is `true` when pressed, and `false` when not pressed. This button can sometimes be labeled as the Forward button on some gamepads.

Access functions:

bool | buttonStart() const

Notifier signal:

void | buttonStartChanged(bool value)

### buttonUp : const bool

This read-only property holds the state of the direction pad up button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonUp() const

Notifier signal:

void | buttonUpChanged(bool value)

### buttonX : const bool

This read-only property holds the state of the X button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonX() const

Notifier signal:

void | buttonXChanged(bool value)

### buttonY : const bool

This read-only property holds the state of the Y button. The value is `true` when pressed, and `false` when not pressed.

Access functions:

bool | buttonY() const

Notifier signal:

void | buttonYChanged(bool value)

### connected : const bool

This read-only property holds the connectivity state of the gamepad device. If a gamepad is connected, this property will be true, otherwise false.

Access functions:

bool | isConnected() const

Notifier signal:

void | connectedChanged(bool value)

### deviceId : int

This property holds the deviceId of the gamepad device. Multiple gamepad devices can be connected at any given time, so setting this property defines which gamepad to use.

Access functions:

int | deviceId() const
void | setDeviceId(int number)

Notifier signal:

void | deviceIdChanged(int value)

See also QGamepadManager::connectedGamepads().

### name : const QString

This read-only property holds the reported name of the gamepad if one is available.

Access functions:

QString | name() const

Notifier signal:

void | nameChanged(QString value)

## Member Function Documentation

### QGamepad::QGamepad(int deviceId = 0, QObject *parent = nullptr)

Constructs a QGamepad with the given deviceId and parent.

### QGamepad::~QGamepad()

Destroys the QGamepad.