193 lines
16 KiB
HTML
193 lines
16 KiB
HTML
<!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&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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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 Page</span></a></li>
|
|
<li><a href="topics.html"><span>Topics</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><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()"> </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="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c0a853e81d6f1c1f0a3eb7a27dc24256.html">SFML</a></li><li class="navelem"><a class="el" href="dir_5cf786e58cbf7297a26339ae6e44357c.html">Window</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">Joystick.hpp File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <<a class="el" href="Window_2Export_8hpp_source.html">SFML/Window/Export.hpp</a>></code><br />
|
|
<code>#include <<a class="el" href="String_8hpp_source.html">SFML/System/String.hpp</a>></code><br />
|
|
</div>
|
|
<p><a href="Joystick_8hpp_source.html">Go to the source code of this file.</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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1Joystick_1_1Identification.html">sf::Joystick::Identification</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf.html">sf</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html">sf::Joystick</a></td></tr>
|
|
<tr class="memdesc:namespacesf_1_1Joystick"><td class="mdescLeft"> </td><td class="mdescRight">Give access to the real-time state of the joysticks. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7">sf::Joystick::Axis</a> { <br />
|
|
  <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7a02129bb861061d1a052c592e2dc6b383">sf::Joystick::X</a>
|
|
, <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7a57cec4137b614c87cb4e24a3d003a3e0">sf::Joystick::Y</a>
|
|
, <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7a21c2e59531c8710156d34a3c30ac81d5">sf::Joystick::Z</a>
|
|
, <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7ae1e1d3d40573127e9ee0480caf1283d6">sf::Joystick::R</a>
|
|
, <br />
|
|
  <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7a4c614360da93c0a041b22e537de151eb">sf::Joystick::U</a>
|
|
, <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7a5206560a306a2e085a437fd258eb57ce">sf::Joystick::V</a>
|
|
, <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7a783ee6cd28c54605c9ef0453ff213692">sf::Joystick::PovX</a>
|
|
, <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7ad5145e1dd4aa9600d94cad6ec92e94e5">sf::Joystick::PovY</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a48db337092c2e263774f94de6d50baa7"><td class="mdescLeft"> </td><td class="mdescRight">Axes supported by SFML joysticks. <a href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7">More...</a><br /></td></tr>
|
|
<tr class="separator:a48db337092c2e263774f94de6d50baa7"><td class="memSeparator" colspan="2"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a8e312bfb03954efa373326dbda3f911d">sf::Joystick::isConnected</a> (unsigned int joystick)</td></tr>
|
|
<tr class="memdesc:a8e312bfb03954efa373326dbda3f911d"><td class="mdescLeft"> </td><td class="mdescRight">Check if a joystick is connected. <br /></td></tr>
|
|
<tr class="separator:a8e312bfb03954efa373326dbda3f911d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31e0644c53d26e46618e5b6acdf2f5f2" id="r_a31e0644c53d26e46618e5b6acdf2f5f2"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a31e0644c53d26e46618e5b6acdf2f5f2">sf::Joystick::getButtonCount</a> (unsigned int joystick)</td></tr>
|
|
<tr class="memdesc:a31e0644c53d26e46618e5b6acdf2f5f2"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:afa7b0a9e74d47067670f37362a655a76" id="r_afa7b0a9e74d47067670f37362a655a76"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#afa7b0a9e74d47067670f37362a655a76">sf::Joystick::hasAxis</a> (unsigned int joystick, <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7">Axis</a> axis)</td></tr>
|
|
<tr class="memdesc:afa7b0a9e74d47067670f37362a655a76"><td class="mdescLeft"> </td><td class="mdescRight">Check if a joystick supports a given axis. <br /></td></tr>
|
|
<tr class="separator:afa7b0a9e74d47067670f37362a655a76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af45b5a3883b80a54ecb9c5a5f1fc78b5" id="r_af45b5a3883b80a54ecb9c5a5f1fc78b5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#af45b5a3883b80a54ecb9c5a5f1fc78b5">sf::Joystick::isButtonPressed</a> (unsigned int joystick, unsigned int button)</td></tr>
|
|
<tr class="memdesc:af45b5a3883b80a54ecb9c5a5f1fc78b5"><td class="mdescLeft"> </td><td class="mdescRight">Check if a joystick button is pressed. <br /></td></tr>
|
|
<tr class="separator:af45b5a3883b80a54ecb9c5a5f1fc78b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a572af0673215579abf76a52665341338" id="r_a572af0673215579abf76a52665341338"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a572af0673215579abf76a52665341338">sf::Joystick::getAxisPosition</a> (unsigned int joystick, <a class="el" href="namespacesf_1_1Joystick.html#a48db337092c2e263774f94de6d50baa7">Axis</a> axis)</td></tr>
|
|
<tr class="memdesc:a572af0673215579abf76a52665341338"><td class="mdescLeft"> </td><td class="mdescRight">Get the current position of a joystick axis. <br /></td></tr>
|
|
<tr class="separator:a572af0673215579abf76a52665341338"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a0981cdfb1554be0eef5e080ee9c0bf27">sf::Joystick::getIdentification</a> (unsigned int joystick)</td></tr>
|
|
<tr class="memdesc:a0981cdfb1554be0eef5e080ee9c0bf27"><td class="mdescLeft"> </td><td class="mdescRight">Get the joystick information. <br /></td></tr>
|
|
<tr class="separator:a0981cdfb1554be0eef5e080ee9c0bf27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a924f051f4c3d66a980918fda6b0ff787" id="r_a924f051f4c3d66a980918fda6b0ff787"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a924f051f4c3d66a980918fda6b0ff787">sf::Joystick::update</a> ()</td></tr>
|
|
<tr class="memdesc:a924f051f4c3d66a980918fda6b0ff787"><td class="mdescLeft"> </td><td class="mdescRight">Update the states of all joysticks. <br /></td></tr>
|
|
<tr class="separator:a924f051f4c3d66a980918fda6b0ff787"><td class="memSeparator" colspan="2"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a459467658a2542bdf56903229e431068">sf::Joystick::Count</a> {8}</td></tr>
|
|
<tr class="memdesc:a459467658a2542bdf56903229e431068"><td class="mdescLeft"> </td><td class="mdescRight">Constants related to joysticks capabilities. <br /></td></tr>
|
|
<tr class="separator:a459467658a2542bdf56903229e431068"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a650d9cc7232acb2b3a32b92166ed0c77" id="r_a650d9cc7232acb2b3a32b92166ed0c77"><td class="memItemLeft" align="right" valign="top">static constexpr unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a650d9cc7232acb2b3a32b92166ed0c77">sf::Joystick::ButtonCount</a> {32}</td></tr>
|
|
<tr class="memdesc:a650d9cc7232acb2b3a32b92166ed0c77"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of supported buttons. <br /></td></tr>
|
|
<tr class="separator:a650d9cc7232acb2b3a32b92166ed0c77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0de8fc66336c6764151d88af5b42d2bb" id="r_a0de8fc66336c6764151d88af5b42d2bb"><td class="memItemLeft" align="right" valign="top">static constexpr unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesf_1_1Joystick.html#a0de8fc66336c6764151d88af5b42d2bb">sf::Joystick::AxisCount</a> {8}</td></tr>
|
|
<tr class="memdesc:a0de8fc66336c6764151d88af5b42d2bb"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of supported axes. <br /></td></tr>
|
|
<tr class="separator:a0de8fc66336c6764151d88af5b42d2bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</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 © Laurent Gomila ::
|
|
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|