<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgamepad.cpp -->
<title>Gamepad QML Type | Qt Gamepad 5.12.2</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtgamepad-index.html">Qt Gamepad</a></td><td ><a href="qtgamepad-qmlmodule.html">QML Types</a></td><td >Gamepad QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtgamepad-index.html">Qt 5.12.2 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Gamepad QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Gamepad-brief -->
<p>A gamepad device connected to a system. <a href="#details">More...</a></p>
<!-- @@@Gamepad -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtGamepad 1.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qtgamepad-gamepad.html"><a href="qgamepad.html">QGamepad</a></td></tr></table></div><ul>
<li><a href="qml-qtgamepad-gamepad-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#axisLeftX-prop">axisLeftX</a></b></b> : double</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#axisLeftY-prop">axisLeftY</a></b></b> : double</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#axisRightX-prop">axisRightX</a></b></b> : double</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#axisRightY-prop">axisRightY</a></b></b> : double</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonL1-prop">buttonL1</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonL2-prop">buttonL2</a></b></b> : double</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonL3-prop">buttonL3</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonR1-prop">buttonR1</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonR2-prop">buttonR2</a></b></b> : double</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonR3-prop">buttonR3</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonA-prop">buttonA</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonB-prop">buttonB</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonDown-prop">buttonDown</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonLeft-prop">buttonLeft</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonRight-prop">buttonRight</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonSelect-prop">buttonSelect</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonStart-prop">buttonStart</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonUp-prop">buttonUp</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonX-prop">buttonX</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#buttonY-prop">buttonY</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#connected-prop">connected</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#deviceId-prop">deviceId</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtgamepad-gamepad.html#name-prop">name</a></b></b> : string</li>
</ul>
<!-- $$$Gamepad-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Gamepad QML type is used to access the current state of gamepad hardware connected to a system</p>
<!-- @@@Gamepad -->
<h2>Property Documentation</h2>
<!-- $$$axisLeftX -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="axisLeftX-prop">
<td class="tblQmlPropNode"><p>
<a name="axisLeftX-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">axisLeftX</span> : <span class="type">double</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The value of the left thumbstick's X axis. The axis values range from -1.0 to 1.0.</p>
</div></div><!-- @@@axisLeftX -->
<br/>
<!-- $$$axisLeftY -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="axisLeftY-prop">
<td class="tblQmlPropNode"><p>
<a name="axisLeftY-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">axisLeftY</span> : <span class="type">double</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The value of the left thumbstick's Y axis. The axis values range from -1.0 to 1.0.</p>
</div></div><!-- @@@axisLeftY -->
<br/>
<!-- $$$axisRightX -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="axisRightX-prop">
<td class="tblQmlPropNode"><p>
<a name="axisRightX-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">axisRightX</span> : <span class="type">double</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This value of the right thumbstick's X axis. The axis values range from -1.0 to 1.0.</p>
</div></div><!-- @@@axisRightX -->
<br/>
<!-- $$$axisRightY -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="axisRightY-prop">
<td class="tblQmlPropNode"><p>
<a name="axisRightY-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">axisRightY</span> : <span class="type">double</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This value of the right thumbstick's Y axis. The axis values range from -1.0 to 1.0.</p>
</div></div><!-- @@@axisRightY -->
<br/>
<!-- $$$buttonL1 -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonL1-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonL1-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonL1</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the left shoulder button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonL1 -->
<br/>
<!-- $$$buttonL2 -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonL2-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonL2-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonL2</span> : <span class="type">double</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The value of the left trigger button. This trigger value ranges from 0.0 when not pressed to 1.0 when pressed completely.</p>
</div></div><!-- @@@buttonL2 -->
<br/>
<!-- $$$buttonL3 -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonL3-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonL3-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonL3</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the left stick button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed. This button is usually triggered by pressing the left joystick itself.</p>
</div></div><!-- @@@buttonL3 -->
<br/>
<!-- $$$buttonR1 -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonR1-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonR1-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonR1</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the right shoulder button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonR1 -->
<br/>
<!-- $$$buttonR2 -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonR2-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonR2-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonR2</span> : <span class="type">double</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The value of the right trigger button. This trigger value ranges from 0.0 when not pressed to 1.0 when pressed completely.</p>
</div></div><!-- @@@buttonR2 -->
<br/>
<!-- $$$buttonR3 -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonR3-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonR3-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonR3</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the right stick button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed. This button is usually triggered by pressing the right joystick itself.</p>
</div></div><!-- @@@buttonR3 -->
<br/>
<!-- $$$buttonA -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonA-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonA-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonA</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the A button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonA -->
<br/>
<!-- $$$buttonB -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonB-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonB-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonB</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the B button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
<p><b>See also </b>GamepadManager::connectedGamepads().</p>
</div></div><!-- @@@buttonB -->
<br/>
<!-- $$$buttonDown -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonDown-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonDown-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonDown</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The of the direction pad down button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonDown -->
<br/>
<!-- $$$buttonLeft -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonLeft-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonLeft-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonLeft</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the direction pad left button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonLeft -->
<br/>
<!-- $$$buttonRight -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonRight-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonRight-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonRight</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the direction pad right button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonRight -->
<br/>
<!-- $$$buttonSelect -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonSelect-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonSelect-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonSelect</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the Select button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed. This button can sometimes be labeled as the Back button on some gamepads.</p>
</div></div><!-- @@@buttonSelect -->
<br/>
<!-- $$$buttonStart -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonStart-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonStart-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonStart</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the Start button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed. This button can sometimes be labeled as the Forward button on some gamepads.</p>
</div></div><!-- @@@buttonStart -->
<br/>
<!-- $$$buttonUp -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonUp-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonUp-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonUp</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the direction pad up button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonUp -->
<br/>
<!-- $$$buttonX -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonX-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonX-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonX</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the X button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonX -->
<br/>
<!-- $$$buttonY -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttonY-prop">
<td class="tblQmlPropNode"><p>
<a name="buttonY-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">buttonY</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The state of the Y button. The value is <code>true</code> when pressed, and <code>false</code> when not pressed.</p>
</div></div><!-- @@@buttonY -->
<br/>
<!-- $$$connected -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="connected-prop">
<td class="tblQmlPropNode"><p>
<a name="connected-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">connected</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The connectivity state of the gamepad device. If a gamepad is connected, this property will be true, otherwise false.</p>
</div></div><!-- @@@connected -->
<br/>
<!-- $$$deviceId -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="deviceId-prop">
<td class="tblQmlPropNode"><p>
<a name="deviceId-prop"></a><span class="name">deviceId</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>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.</p>
<p><b>See also </b>GamepadManager::connectedGamepads().</p>
</div></div><!-- @@@deviceId -->
<br/>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="name-prop">
<td class="tblQmlPropNode"><p>
<a name="name-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">name</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The reported name of the gamepad if one is available.</p>
</div></div><!-- @@@name -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
