<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML</span>
</div>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f3190241575fd2bd132a392ae6942f4a.htm">include</a></li><li class="navelem"><a class="el" href="dir_692f376662c82a26cfe4cfa3aceebe24.htm">SFML</a></li><li class="navelem"><a class="el" href="dir_91aff02cfffdbbdd31d48df547831556.htm">Window</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Joystick.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// you must not claim that you wrote the original software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and must not be misrepresented as being the original software.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">//</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef SFML_JOYSTICK_HPP</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define SFML_JOYSTICK_HPP</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Headers</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#include <SFML/Window/Export.hpp></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>sf</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm"> 40</a></span> <span class="keyword">class </span>SFML_WINDOW_API <a class="code" href="classsf_1_1Joystick.htm" title="Give access to the real-time state of the joysticks.">Joystick</a></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">public</span> :</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">enum</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a951a7c775921304a5f3443c6e2bb4d65a6e0a2a95bc1da277610c04d80f52715e"> 50</a></span> Count = 8, </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a951a7c775921304a5f3443c6e2bb4d65a2f1b8a0a59f2c12a4775c0e1e69e1816"> 51</a></span> ButtonCount = 32, </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a951a7c775921304a5f3443c6e2bb4d65accf3e487c9f6ee2f384351323626a42c"> 52</a></span> AxisCount = 8 </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> };</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7"> 59</a></span> <span class="keyword">enum</span> <a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7" title="Axes supported by SFML joysticks.">Axis</a></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a95dc8b9bf7b0a2157fc67891c54c401e"> 61</a></span> <a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a95dc8b9bf7b0a2157fc67891c54c401e" title="The X axis.">X</a>, </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a51ef1455f7511ad4a78ba241d66593ce"> 62</a></span> <a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a51ef1455f7511ad4a78ba241d66593ce" title="The Y axis.">Y</a>, </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a7c37a1240b2dafbbfc5c1a0e23911315"> 63</a></span> <a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a7c37a1240b2dafbbfc5c1a0e23911315" title="The Z axis.">Z</a>, </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7aeebbcdb0828850f4d69e6a084801fab8"> 64</a></span> <a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7aeebbcdb0828850f4d69e6a084801fab8" title="The R axis.">R</a>, </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a0a901f61e75292dd2f642b6e4f33a214"> 65</a></span> <a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a0a901f61e75292dd2f642b6e4f33a214" title="The U axis.">U</a>, </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7aa2e2c8ffa1837e7911ee0c7d045bf8f4"> 66</a></span> <a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7aa2e2c8ffa1837e7911ee0c7d045bf8f4" title="The V axis.">V</a>, </div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a06420f7714e4dfd8b841885a0b5f3954"> 67</a></span> <a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a06420f7714e4dfd8b841885a0b5f3954" title="The X axis of the point-of-view hat.">PovX</a>, </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="classsf_1_1Joystick.htm#a48db337092c2e263774f94de6d50baa7a0f8ffb2dcddf91b98ab910a4f8327ad9"> 68</a></span> PovY </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> isConnected(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> joystick);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getButtonCount(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> joystick);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> hasAxis(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> joystick, Axis axis);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> isButtonPressed(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> joystick, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> button);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="keyword">static</span> <span class="keywordtype">float</span> getAxisPosition(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> joystick, Axis axis);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="keyword">static</span> <span class="keywordtype">void</span> update();</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> };</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> } <span class="comment">// namespace sf</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#endif // SFML_JOYSTICK_HPP</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
Copyright � Laurent Gomila ::
</div>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-41898676-1', 'srchub.org');
ga('send', 'pageview');
