joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/namespacesf_1_1Joystick.html

585 lines
35 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="namespacesf_1_1Joystick.html">Joystick</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">sf::Joystick Namespace Reference<div class="ingroups"><a class="el" href="group__window.html">Window module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Give access to the real-time state of the joysticks.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Joystick_1_1Identification.html">Identification</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure holding a joystick's identification. <a href="structsf_1_1Joystick_1_1Identification.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a48db337092c2e263774f94de6d50baa7" id="r_a48db337092c2e263774f94de6d50baa7"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a48db337092c2e263774f94de6d50baa7">Axis</a> { <br />
&#160;&#160;<a class="el" href="#a48db337092c2e263774f94de6d50baa7a02129bb861061d1a052c592e2dc6b383">X</a>
, <a class="el" href="#a48db337092c2e263774f94de6d50baa7a57cec4137b614c87cb4e24a3d003a3e0">Y</a>
, <a class="el" href="#a48db337092c2e263774f94de6d50baa7a21c2e59531c8710156d34a3c30ac81d5">Z</a>
, <a class="el" href="#a48db337092c2e263774f94de6d50baa7ae1e1d3d40573127e9ee0480caf1283d6">R</a>
, <br />
&#160;&#160;<a class="el" href="#a48db337092c2e263774f94de6d50baa7a4c614360da93c0a041b22e537de151eb">U</a>
, <a class="el" href="#a48db337092c2e263774f94de6d50baa7a5206560a306a2e085a437fd258eb57ce">V</a>
, <a class="el" href="#a48db337092c2e263774f94de6d50baa7a783ee6cd28c54605c9ef0453ff213692">PovX</a>
, <a class="el" href="#a48db337092c2e263774f94de6d50baa7ad5145e1dd4aa9600d94cad6ec92e94e5">PovY</a>
<br />
}</td></tr>
<tr class="memdesc:a48db337092c2e263774f94de6d50baa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Axes supported by SFML joysticks. <a href="#a48db337092c2e263774f94de6d50baa7">More...</a><br /></td></tr>
<tr class="separator:a48db337092c2e263774f94de6d50baa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8e312bfb03954efa373326dbda3f911d" id="r_a8e312bfb03954efa373326dbda3f911d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e312bfb03954efa373326dbda3f911d">isConnected</a> (unsigned int joystick)</td></tr>
<tr class="memdesc:a8e312bfb03954efa373326dbda3f911d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a joystick is connected. <br /></td></tr>
<tr class="separator:a8e312bfb03954efa373326dbda3f911d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31e0644c53d26e46618e5b6acdf2f5f2" id="r_a31e0644c53d26e46618e5b6acdf2f5f2"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a31e0644c53d26e46618e5b6acdf2f5f2">getButtonCount</a> (unsigned int joystick)</td></tr>
<tr class="memdesc:a31e0644c53d26e46618e5b6acdf2f5f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of buttons supported by a joystick. <br /></td></tr>
<tr class="separator:a31e0644c53d26e46618e5b6acdf2f5f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa7b0a9e74d47067670f37362a655a76" id="r_afa7b0a9e74d47067670f37362a655a76"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa7b0a9e74d47067670f37362a655a76">hasAxis</a> (unsigned int joystick, <a class="el" href="#a48db337092c2e263774f94de6d50baa7">Axis</a> axis)</td></tr>
<tr class="memdesc:afa7b0a9e74d47067670f37362a655a76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a joystick supports a given axis. <br /></td></tr>
<tr class="separator:afa7b0a9e74d47067670f37362a655a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af45b5a3883b80a54ecb9c5a5f1fc78b5" id="r_af45b5a3883b80a54ecb9c5a5f1fc78b5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af45b5a3883b80a54ecb9c5a5f1fc78b5">isButtonPressed</a> (unsigned int joystick, unsigned int button)</td></tr>
<tr class="memdesc:af45b5a3883b80a54ecb9c5a5f1fc78b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a joystick button is pressed. <br /></td></tr>
<tr class="separator:af45b5a3883b80a54ecb9c5a5f1fc78b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a572af0673215579abf76a52665341338" id="r_a572af0673215579abf76a52665341338"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a572af0673215579abf76a52665341338">getAxisPosition</a> (unsigned int joystick, <a class="el" href="#a48db337092c2e263774f94de6d50baa7">Axis</a> axis)</td></tr>
<tr class="memdesc:a572af0673215579abf76a52665341338"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current position of a joystick axis. <br /></td></tr>
<tr class="separator:a572af0673215579abf76a52665341338"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0981cdfb1554be0eef5e080ee9c0bf27" id="r_a0981cdfb1554be0eef5e080ee9c0bf27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsf_1_1Joystick_1_1Identification.html">Identification</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0981cdfb1554be0eef5e080ee9c0bf27">getIdentification</a> (unsigned int joystick)</td></tr>
<tr class="memdesc:a0981cdfb1554be0eef5e080ee9c0bf27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the joystick information. <br /></td></tr>
<tr class="separator:a0981cdfb1554be0eef5e080ee9c0bf27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a924f051f4c3d66a980918fda6b0ff787" id="r_a924f051f4c3d66a980918fda6b0ff787"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a924f051f4c3d66a980918fda6b0ff787">update</a> ()</td></tr>
<tr class="memdesc:a924f051f4c3d66a980918fda6b0ff787"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update the states of all joysticks. <br /></td></tr>
<tr class="separator:a924f051f4c3d66a980918fda6b0ff787"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a459467658a2542bdf56903229e431068" id="r_a459467658a2542bdf56903229e431068"><td class="memItemLeft" align="right" valign="top">static constexpr unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a459467658a2542bdf56903229e431068">Count</a> {8}</td></tr>
<tr class="memdesc:a459467658a2542bdf56903229e431068"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constants related to joysticks capabilities. <br /></td></tr>
<tr class="separator:a459467658a2542bdf56903229e431068"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a650d9cc7232acb2b3a32b92166ed0c77" id="r_a650d9cc7232acb2b3a32b92166ed0c77"><td class="memItemLeft" align="right" valign="top">static constexpr unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a650d9cc7232acb2b3a32b92166ed0c77">ButtonCount</a> {32}</td></tr>
<tr class="memdesc:a650d9cc7232acb2b3a32b92166ed0c77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of supported buttons. <br /></td></tr>
<tr class="separator:a650d9cc7232acb2b3a32b92166ed0c77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0de8fc66336c6764151d88af5b42d2bb" id="r_a0de8fc66336c6764151d88af5b42d2bb"><td class="memItemLeft" align="right" valign="top">static constexpr unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0de8fc66336c6764151d88af5b42d2bb">AxisCount</a> {8}</td></tr>
<tr class="memdesc:a0de8fc66336c6764151d88af5b42d2bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of supported axes. <br /></td></tr>
<tr class="separator:a0de8fc66336c6764151d88af5b42d2bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Give access to the real-time state of the joysticks. </p>
<p><code><a class="el" href="namespacesf_1_1Joystick.html" title="Give access to the real-time state of the joysticks.">sf::Joystick</a></code> provides an interface to the state of the joysticks.</p>
<p>Each joystick is identified by an index that is passed to the functions in this namespace.</p>
<p>This namespace allows users to query the state of joysticks at any time and directly, without having to deal with a window and its events. Compared to the <code>JoystickMoved</code>, <code>JoystickButtonPressed</code> and <code>JoystickButtonReleased</code> events, <code><a class="el" href="namespacesf_1_1Joystick.html" title="Give access to the real-time state of the joysticks.">sf::Joystick</a></code> can retrieve the state of axes and buttons of joysticks at any time (you don't need to store and update a boolean on your side in order to know if a button is pressed or released), and you always get the real state of joysticks, even if they are moved, pressed or released when your window is out of focus and no event is triggered.</p>
<p>SFML supports: </p><ul>
<li>8 joysticks (<code><a class="el" href="#a459467658a2542bdf56903229e431068" title="Constants related to joysticks capabilities.">sf::Joystick::Count</a></code>) </li>
<li>32 buttons per joystick (<code><a class="el" href="#a650d9cc7232acb2b3a32b92166ed0c77" title="Maximum number of supported buttons.">sf::Joystick::ButtonCount</a></code>) </li>
<li>8 axes per joystick (<code><a class="el" href="#a0de8fc66336c6764151d88af5b42d2bb" title="Maximum number of supported axes.">sf::Joystick::AxisCount</a></code>)</li>
</ul>
<p>Unlike the keyboard or mouse, the state of joysticks is sometimes not directly available (depending on the OS), therefore an <code><a class="el" href="#a924f051f4c3d66a980918fda6b0ff787" title="Update the states of all joysticks.">update()</a></code> function must be called in order to update the current state of joysticks. When you have a window with event handling, this is done automatically, you don't need to call anything. But if you have no window, or if you want to check joysticks state before creating one, you must call <code><a class="el" href="#a924f051f4c3d66a980918fda6b0ff787" title="Update the states of all joysticks.">sf::Joystick::update</a></code> explicitly.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="comment">// Is joystick #0 connected?</span></div>
<div class="line"><span class="keywordtype">bool</span> connected = <a class="code hl_function" href="#a8e312bfb03954efa373326dbda3f911d">sf::Joystick::isConnected</a>(0);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// How many buttons does joystick #0 support?</span></div>
<div class="line"><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> buttons = <a class="code hl_function" href="#a31e0644c53d26e46618e5b6acdf2f5f2">sf::Joystick::getButtonCount</a>(0);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Does joystick #0 define a X axis?</span></div>
<div class="line"><span class="keywordtype">bool</span> hasX = <a class="code hl_function" href="#afa7b0a9e74d47067670f37362a655a76">sf::Joystick::hasAxis</a>(0, <a class="code hl_enumvalue" href="#a48db337092c2e263774f94de6d50baa7a02129bb861061d1a052c592e2dc6b383">sf::Joystick::Axis::X</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Is button #2 pressed on joystick #0?</span></div>
<div class="line"><span class="keywordtype">bool</span> pressed = <a class="code hl_function" href="#af45b5a3883b80a54ecb9c5a5f1fc78b5">sf::Joystick::isButtonPressed</a>(0, 2);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// What&#39;s the current position of the Y axis on joystick #0?</span></div>
<div class="line"><span class="keywordtype">float</span> position = <a class="code hl_function" href="#a572af0673215579abf76a52665341338">sf::Joystick::getAxisPosition</a>(0, <a class="code hl_enumvalue" href="#a48db337092c2e263774f94de6d50baa7a57cec4137b614c87cb4e24a3d003a3e0">sf::Joystick::Axis::Y</a>);</div>
<div class="ttc" id="anamespacesf_1_1Joystick_html_a31e0644c53d26e46618e5b6acdf2f5f2"><div class="ttname"><a href="#a31e0644c53d26e46618e5b6acdf2f5f2">sf::Joystick::getButtonCount</a></div><div class="ttdeci">unsigned int getButtonCount(unsigned int joystick)</div><div class="ttdoc">Return the number of buttons supported by a joystick.</div></div>
<div class="ttc" id="anamespacesf_1_1Joystick_html_a48db337092c2e263774f94de6d50baa7a02129bb861061d1a052c592e2dc6b383"><div class="ttname"><a href="#a48db337092c2e263774f94de6d50baa7a02129bb861061d1a052c592e2dc6b383">sf::Joystick::Axis::X</a></div><div class="ttdeci">@ X</div><div class="ttdoc">The X axis.</div></div>
<div class="ttc" id="anamespacesf_1_1Joystick_html_a48db337092c2e263774f94de6d50baa7a57cec4137b614c87cb4e24a3d003a3e0"><div class="ttname"><a href="#a48db337092c2e263774f94de6d50baa7a57cec4137b614c87cb4e24a3d003a3e0">sf::Joystick::Axis::Y</a></div><div class="ttdeci">@ Y</div><div class="ttdoc">The Y axis.</div></div>
<div class="ttc" id="anamespacesf_1_1Joystick_html_a572af0673215579abf76a52665341338"><div class="ttname"><a href="#a572af0673215579abf76a52665341338">sf::Joystick::getAxisPosition</a></div><div class="ttdeci">float getAxisPosition(unsigned int joystick, Axis axis)</div><div class="ttdoc">Get the current position of a joystick axis.</div></div>
<div class="ttc" id="anamespacesf_1_1Joystick_html_a8e312bfb03954efa373326dbda3f911d"><div class="ttname"><a href="#a8e312bfb03954efa373326dbda3f911d">sf::Joystick::isConnected</a></div><div class="ttdeci">bool isConnected(unsigned int joystick)</div><div class="ttdoc">Check if a joystick is connected.</div></div>
<div class="ttc" id="anamespacesf_1_1Joystick_html_af45b5a3883b80a54ecb9c5a5f1fc78b5"><div class="ttname"><a href="#af45b5a3883b80a54ecb9c5a5f1fc78b5">sf::Joystick::isButtonPressed</a></div><div class="ttdeci">bool isButtonPressed(unsigned int joystick, unsigned int button)</div><div class="ttdoc">Check if a joystick button is pressed.</div></div>
<div class="ttc" id="anamespacesf_1_1Joystick_html_afa7b0a9e74d47067670f37362a655a76"><div class="ttname"><a href="#afa7b0a9e74d47067670f37362a655a76">sf::Joystick::hasAxis</a></div><div class="ttdeci">bool hasAxis(unsigned int joystick, Axis axis)</div><div class="ttdoc">Check if a joystick supports a given axis.</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="namespacesf_1_1Keyboard.html" title="Give access to the real-time state of the keyboard.">sf::Keyboard</a></code>, <code><a class="el" href="namespacesf_1_1Mouse.html" title="Give access to the real-time state of the mouse.">sf::Mouse</a></code> </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a48db337092c2e263774f94de6d50baa7" name="a48db337092c2e263774f94de6d50baa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48db337092c2e263774f94de6d50baa7">&#9670;&#160;</a></span>Axis</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#a48db337092c2e263774f94de6d50baa7">sf::Joystick::Axis</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Axes supported by SFML joysticks. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a48db337092c2e263774f94de6d50baa7a02129bb861061d1a052c592e2dc6b383" name="a48db337092c2e263774f94de6d50baa7a02129bb861061d1a052c592e2dc6b383"></a>X&#160;</td><td class="fielddoc"><p>The X axis. </p>
</td></tr>
<tr><td class="fieldname"><a id="a48db337092c2e263774f94de6d50baa7a57cec4137b614c87cb4e24a3d003a3e0" name="a48db337092c2e263774f94de6d50baa7a57cec4137b614c87cb4e24a3d003a3e0"></a>Y&#160;</td><td class="fielddoc"><p>The Y axis. </p>
</td></tr>
<tr><td class="fieldname"><a id="a48db337092c2e263774f94de6d50baa7a21c2e59531c8710156d34a3c30ac81d5" name="a48db337092c2e263774f94de6d50baa7a21c2e59531c8710156d34a3c30ac81d5"></a>Z&#160;</td><td class="fielddoc"><p>The Z axis. </p>
</td></tr>
<tr><td class="fieldname"><a id="a48db337092c2e263774f94de6d50baa7ae1e1d3d40573127e9ee0480caf1283d6" name="a48db337092c2e263774f94de6d50baa7ae1e1d3d40573127e9ee0480caf1283d6"></a>R&#160;</td><td class="fielddoc"><p>The R axis. </p>
</td></tr>
<tr><td class="fieldname"><a id="a48db337092c2e263774f94de6d50baa7a4c614360da93c0a041b22e537de151eb" name="a48db337092c2e263774f94de6d50baa7a4c614360da93c0a041b22e537de151eb"></a>U&#160;</td><td class="fielddoc"><p>The U axis. </p>
</td></tr>
<tr><td class="fieldname"><a id="a48db337092c2e263774f94de6d50baa7a5206560a306a2e085a437fd258eb57ce" name="a48db337092c2e263774f94de6d50baa7a5206560a306a2e085a437fd258eb57ce"></a>V&#160;</td><td class="fielddoc"><p>The V axis. </p>
</td></tr>
<tr><td class="fieldname"><a id="a48db337092c2e263774f94de6d50baa7a783ee6cd28c54605c9ef0453ff213692" name="a48db337092c2e263774f94de6d50baa7a783ee6cd28c54605c9ef0453ff213692"></a>PovX&#160;</td><td class="fielddoc"><p>The X axis of the point-of-view hat. </p>
</td></tr>
<tr><td class="fieldname"><a id="a48db337092c2e263774f94de6d50baa7ad5145e1dd4aa9600d94cad6ec92e94e5" name="a48db337092c2e263774f94de6d50baa7ad5145e1dd4aa9600d94cad6ec92e94e5"></a>PovY&#160;</td><td class="fielddoc"><p>The Y axis of the point-of-view hat. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="Joystick_8hpp_source.html#l00054">54</a> of file <a class="el" href="Joystick_8hpp_source.html">Joystick.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a572af0673215579abf76a52665341338" name="a572af0673215579abf76a52665341338"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a572af0673215579abf76a52665341338">&#9670;&#160;</a></span>getAxisPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float sf::Joystick::getAxisPosition </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>joystick</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a48db337092c2e263774f94de6d50baa7">Axis</a></td> <td class="paramname"><span class="paramname"><em>axis</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current position of a joystick axis. </p>
<p>If the joystick is not connected, this function returns 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">joystick</td><td>Index of the joystick </td></tr>
<tr><td class="paramname">axis</td><td>Axis to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current position of the axis, in range [-100 .. 100] </dd></dl>
</div>
</div>
<a id="a31e0644c53d26e46618e5b6acdf2f5f2" name="a31e0644c53d26e46618e5b6acdf2f5f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31e0644c53d26e46618e5b6acdf2f5f2">&#9670;&#160;</a></span>getButtonCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::Joystick::getButtonCount </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>joystick</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of buttons supported by a joystick. </p>
<p>If the joystick is not connected, this function returns 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">joystick</td><td>Index of the joystick</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of buttons supported by the joystick </dd></dl>
</div>
</div>
<a id="a0981cdfb1554be0eef5e080ee9c0bf27" name="a0981cdfb1554be0eef5e080ee9c0bf27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0981cdfb1554be0eef5e080ee9c0bf27">&#9670;&#160;</a></span>getIdentification()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsf_1_1Joystick_1_1Identification.html">Identification</a> sf::Joystick::getIdentification </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>joystick</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the joystick information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">joystick</td><td>Index of the joystick</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Structure containing joystick information. </dd></dl>
</div>
</div>
<a id="afa7b0a9e74d47067670f37362a655a76" name="afa7b0a9e74d47067670f37362a655a76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa7b0a9e74d47067670f37362a655a76">&#9670;&#160;</a></span>hasAxis()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::Joystick::hasAxis </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>joystick</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a48db337092c2e263774f94de6d50baa7">Axis</a></td> <td class="paramname"><span class="paramname"><em>axis</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a joystick supports a given axis. </p>
<p>If the joystick is not connected, this function returns <code>false</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">joystick</td><td>Index of the joystick </td></tr>
<tr><td class="paramname">axis</td><td>Axis to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the joystick supports the axis, <code>false</code> otherwise </dd></dl>
</div>
</div>
<a id="af45b5a3883b80a54ecb9c5a5f1fc78b5" name="af45b5a3883b80a54ecb9c5a5f1fc78b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af45b5a3883b80a54ecb9c5a5f1fc78b5">&#9670;&#160;</a></span>isButtonPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::Joystick::isButtonPressed </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>joystick</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>button</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a joystick button is pressed. </p>
<p>If the joystick is not connected, this function returns <code>false</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">joystick</td><td>Index of the joystick </td></tr>
<tr><td class="paramname">button</td><td>Button to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the button is pressed, <code>false</code> otherwise </dd></dl>
</div>
</div>
<a id="a8e312bfb03954efa373326dbda3f911d" name="a8e312bfb03954efa373326dbda3f911d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e312bfb03954efa373326dbda3f911d">&#9670;&#160;</a></span>isConnected()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::Joystick::isConnected </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>joystick</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a joystick is connected. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">joystick</td><td>Index of the joystick to check</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the joystick is connected, <code>false</code> otherwise </dd></dl>
</div>
</div>
<a id="a924f051f4c3d66a980918fda6b0ff787" name="a924f051f4c3d66a980918fda6b0ff787"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a924f051f4c3d66a980918fda6b0ff787">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Joystick::update </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the states of all joysticks. </p>
<p>This function is used internally by SFML, so you normally don't have to call it explicitly. However, you may need to call it if you have no window yet (or no window at all): in this case the joystick states are not updated automatically. </p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a0de8fc66336c6764151d88af5b42d2bb" name="a0de8fc66336c6764151d88af5b42d2bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0de8fc66336c6764151d88af5b42d2bb">&#9670;&#160;</a></span>AxisCount</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::Joystick::AxisCount {8}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of supported axes. </p>
<p class="definition">Definition at line <a class="el" href="Joystick_8hpp_source.html#l00047">47</a> of file <a class="el" href="Joystick_8hpp_source.html">Joystick.hpp</a>.</p>
</div>
</div>
<a id="a650d9cc7232acb2b3a32b92166ed0c77" name="a650d9cc7232acb2b3a32b92166ed0c77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a650d9cc7232acb2b3a32b92166ed0c77">&#9670;&#160;</a></span>ButtonCount</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::Joystick::ButtonCount {32}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of supported buttons. </p>
<p class="definition">Definition at line <a class="el" href="Joystick_8hpp_source.html#l00046">46</a> of file <a class="el" href="Joystick_8hpp_source.html">Joystick.hpp</a>.</p>
</div>
</div>
<a id="a459467658a2542bdf56903229e431068" name="a459467658a2542bdf56903229e431068"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a459467658a2542bdf56903229e431068">&#9670;&#160;</a></span>Count</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::Joystick::Count {8}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constants related to joysticks capabilities. </p>
<p>Maximum number of supported joysticks </p>
<p class="definition">Definition at line <a class="el" href="Joystick_8hpp_source.html#l00045">45</a> of file <a class="el" href="Joystick_8hpp_source.html">Joystick.hpp</a>.</p>
</div>
</div>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink