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_1Touch.html

263 lines
16 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_1Touch.html">Touch</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sf::Touch 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 touches.
<a href="#details">More...</a></p>
<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:a16ec0dde98706dcd9144a4263466571a" id="r_a16ec0dde98706dcd9144a4263466571a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a16ec0dde98706dcd9144a4263466571a">isDown</a> (unsigned int finger)</td></tr>
<tr class="memdesc:a16ec0dde98706dcd9144a4263466571a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a touch event is currently down. <br /></td></tr>
<tr class="separator:a16ec0dde98706dcd9144a4263466571a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5d31f537862622b3bd0fa738ba37d43" id="r_ae5d31f537862622b3bd0fa738ba37d43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5d31f537862622b3bd0fa738ba37d43">getPosition</a> (unsigned int finger)</td></tr>
<tr class="memdesc:ae5d31f537862622b3bd0fa738ba37d43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current position of a touch in desktop coordinates. <br /></td></tr>
<tr class="separator:ae5d31f537862622b3bd0fa738ba37d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fac8d46a80ad81f8339327d5edd0d3" id="r_a33fac8d46a80ad81f8339327d5edd0d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33fac8d46a80ad81f8339327d5edd0d3">getPosition</a> (unsigned int finger, const <a class="el" href="classsf_1_1WindowBase.html">WindowBase</a> &amp;relativeTo)</td></tr>
<tr class="memdesc:a33fac8d46a80ad81f8339327d5edd0d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current position of a touch in window coordinates. <br /></td></tr>
<tr class="separator:a33fac8d46a80ad81f8339327d5edd0d3"><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 touches. </p>
<p><code><a class="el" href="namespacesf_1_1Touch.html" title="Give access to the real-time state of the touches.">sf::Touch</a></code> provides an interface to the state of the touches.</p>
<p>This namespace allows users to query the touches state at any time and directly, without having to deal with a window and its events. Compared to the <code>TouchBegan</code>, <code>TouchMoved</code> and <code>TouchEnded</code> events, <code><a class="el" href="namespacesf_1_1Touch.html" title="Give access to the real-time state of the touches.">sf::Touch</a></code> can retrieve the state of the touches at any time (you don't need to store and update a boolean on your side in order to know if a touch is down), and you always get the real state of the touches, even if they happen when your window is out of focus and no event is triggered.</p>
<p>The getPosition function can be used to retrieve the current position of a touch. There are two versions: one that operates in global coordinates (relative to the desktop) and one that operates in window coordinates (relative to a specific window).</p>
<p>Touches are identified by an index (the "finger"), so that in multi-touch events, individual touches can be tracked correctly. As long as a finger touches the screen, it will keep the same index even if other fingers start or stop touching the screen in the meantime. As a consequence, active touch indices may not always be sequential (i.e. touch number 0 may be released while touch number 1 is still down).</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="keywordflow">if</span> (<a class="code hl_function" href="#a16ec0dde98706dcd9144a4263466571a">sf::Touch::isDown</a>(0))</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// touch 0 is down</span></div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// get global position of touch 1</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1Vector2.html">sf::Vector2i</a> globalPos = <a class="code hl_function" href="#ae5d31f537862622b3bd0fa738ba37d43">sf::Touch::getPosition</a>(1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// get position of touch 1 relative to a window</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1Vector2.html">sf::Vector2i</a> relativePos = <a class="code hl_function" href="#ae5d31f537862622b3bd0fa738ba37d43">sf::Touch::getPosition</a>(1, window);</div>
<div class="ttc" id="aclasssf_1_1Vector2_html"><div class="ttname"><a href="classsf_1_1Vector2.html">sf::Vector2&lt; int &gt;</a></div></div>
<div class="ttc" id="anamespacesf_1_1Touch_html_a16ec0dde98706dcd9144a4263466571a"><div class="ttname"><a href="#a16ec0dde98706dcd9144a4263466571a">sf::Touch::isDown</a></div><div class="ttdeci">bool isDown(unsigned int finger)</div><div class="ttdoc">Check if a touch event is currently down.</div></div>
<div class="ttc" id="anamespacesf_1_1Touch_html_ae5d31f537862622b3bd0fa738ba37d43"><div class="ttname"><a href="#ae5d31f537862622b3bd0fa738ba37d43">sf::Touch::getPosition</a></div><div class="ttdeci">Vector2i getPosition(unsigned int finger)</div><div class="ttdoc">Get the current position of a touch in desktop coordinates.</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="namespacesf_1_1Joystick.html" title="Give access to the real-time state of the joysticks.">sf::Joystick</a></code>, <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">Function Documentation</h2>
<a id="ae5d31f537862622b3bd0fa738ba37d43" name="ae5d31f537862622b3bd0fa738ba37d43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5d31f537862622b3bd0fa738ba37d43">&#9670;&#160;</a></span>getPosition() <span class="overload">[1/2]</span></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="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> sf::Touch::getPosition </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>finger</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 current position of a touch in desktop coordinates. </p>
<p>This function returns the current touch position in global (desktop) coordinates.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">finger</td><td>Finger index</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current position of <em>finger</em>, or undefined if it's not down </dd></dl>
</div>
</div>
<a id="a33fac8d46a80ad81f8339327d5edd0d3" name="a33fac8d46a80ad81f8339327d5edd0d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33fac8d46a80ad81f8339327d5edd0d3">&#9670;&#160;</a></span>getPosition() <span class="overload">[2/2]</span></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="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> sf::Touch::getPosition </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>finger</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1WindowBase.html">WindowBase</a> &amp;</td> <td class="paramname"><span class="paramname"><em>relativeTo</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 touch in window coordinates. </p>
<p>This function returns the current touch position relative to the given window.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">finger</td><td>Finger index </td></tr>
<tr><td class="paramname">relativeTo</td><td>Reference window</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current position of <em>finger</em>, or undefined if it's not down </dd></dl>
</div>
</div>
<a id="a16ec0dde98706dcd9144a4263466571a" name="a16ec0dde98706dcd9144a4263466571a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16ec0dde98706dcd9144a4263466571a">&#9670;&#160;</a></span>isDown()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::Touch::isDown </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>finger</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 touch event is currently down. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">finger</td><td>Finger index</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <em>finger</em> is currently touching the screen, <code>false</code> otherwise </dd></dl>
</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