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

443 lines
28 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_1Mouse.html">Mouse</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<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::Mouse 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 mouse.
<a href="#details">More...</a></p>
<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:a4fb128be433f9aafe66bc0c605daaa90" id="r_a4fb128be433f9aafe66bc0c605daaa90"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90">Button</a> { <br />
&#160;&#160;<a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90a945d5e233cf7d6240f6b783b36a374ff">Left</a>
, <a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90a92b09c7c48c520c3c55e497875da437c">Right</a>
, <a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90ab1ca34f82e83c52b010f86955f264e05">Middle</a>
, <a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90a113f84d105af2b8016b3896117c9deab">Extra1</a>
, <br />
&#160;&#160;<a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90a83dca46dd08ad782e968d586375715e1">Extra2</a>
<br />
}</td></tr>
<tr class="memdesc:a4fb128be433f9aafe66bc0c605daaa90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mouse buttons. <a href="#a4fb128be433f9aafe66bc0c605daaa90">More...</a><br /></td></tr>
<tr class="separator:a4fb128be433f9aafe66bc0c605daaa90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60dd479a43f26f200e7957aa11803ff4" id="r_a60dd479a43f26f200e7957aa11803ff4"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a60dd479a43f26f200e7957aa11803ff4">Wheel</a> { <a class="el" href="#a60dd479a43f26f200e7957aa11803ff4a06ce2a25e5d12c166a36f654dbea6012">Vertical</a>
, <a class="el" href="#a60dd479a43f26f200e7957aa11803ff4ac1b5fa03ecdb95d4a45dd1c40b02527f">Horizontal</a>
}</td></tr>
<tr class="memdesc:a60dd479a43f26f200e7957aa11803ff4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mouse wheels. <a href="#a60dd479a43f26f200e7957aa11803ff4">More...</a><br /></td></tr>
<tr class="separator:a60dd479a43f26f200e7957aa11803ff4"><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:a2c04cfb3777a682cd83629ab0ba7443d" id="r_a2c04cfb3777a682cd83629ab0ba7443d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c04cfb3777a682cd83629ab0ba7443d">isButtonPressed</a> (<a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90">Button</a> button)</td></tr>
<tr class="memdesc:a2c04cfb3777a682cd83629ab0ba7443d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a mouse button is pressed. <br /></td></tr>
<tr class="separator:a2c04cfb3777a682cd83629ab0ba7443d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad662f5ffc4b5b8c395be6a58d482b5fb" id="r_ad662f5ffc4b5b8c395be6a58d482b5fb"><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="#ad662f5ffc4b5b8c395be6a58d482b5fb">getPosition</a> ()</td></tr>
<tr class="memdesc:ad662f5ffc4b5b8c395be6a58d482b5fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current position of the mouse in desktop coordinates. <br /></td></tr>
<tr class="separator:ad662f5ffc4b5b8c395be6a58d482b5fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88e3e03774b60576ec48a2301f4f57f9" id="r_a88e3e03774b60576ec48a2301f4f57f9"><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="#a88e3e03774b60576ec48a2301f4f57f9">getPosition</a> (const <a class="el" href="classsf_1_1WindowBase.html">WindowBase</a> &amp;relativeTo)</td></tr>
<tr class="memdesc:a88e3e03774b60576ec48a2301f4f57f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current position of the mouse in window coordinates. <br /></td></tr>
<tr class="separator:a88e3e03774b60576ec48a2301f4f57f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cf7dc4def89a2ae4e954fe0f454fed5" id="r_a6cf7dc4def89a2ae4e954fe0f454fed5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6cf7dc4def89a2ae4e954fe0f454fed5">setPosition</a> (<a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> position)</td></tr>
<tr class="memdesc:a6cf7dc4def89a2ae4e954fe0f454fed5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current position of the mouse in desktop coordinates. <br /></td></tr>
<tr class="separator:a6cf7dc4def89a2ae4e954fe0f454fed5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaac27aac9cb5eeb26862550cbc3d583" id="r_aeaac27aac9cb5eeb26862550cbc3d583"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeaac27aac9cb5eeb26862550cbc3d583">setPosition</a> (<a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> position, const <a class="el" href="classsf_1_1WindowBase.html">WindowBase</a> &amp;relativeTo)</td></tr>
<tr class="memdesc:aeaac27aac9cb5eeb26862550cbc3d583"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current position of the mouse in window coordinates. <br /></td></tr>
<tr class="separator:aeaac27aac9cb5eeb26862550cbc3d583"><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:a78384824bc3b006a99ce61b1b04c37f7" id="r_a78384824bc3b006a99ce61b1b04c37f7"><td class="memItemLeft" align="right" valign="top">static constexpr unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a78384824bc3b006a99ce61b1b04c37f7">ButtonCount</a> {5}</td></tr>
<tr class="memdesc:a78384824bc3b006a99ce61b1b04c37f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The total number of mouse buttons. <br /></td></tr>
<tr class="separator:a78384824bc3b006a99ce61b1b04c37f7"><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 mouse. </p>
<p><code><a class="el" href="namespacesf_1_1Mouse.html" title="Give access to the real-time state of the mouse.">sf::Mouse</a></code> provides an interface to the state of the mouse.</p>
<p>A single mouse is assumed.</p>
<p>This namespace allows users to query the mouse state at any time and directly, without having to deal with a window and its events. Compared to the <code>MouseMoved</code>, <code>MouseButtonPressed</code> and <code>MouseButtonReleased</code> events, <code><a class="el" href="namespacesf_1_1Mouse.html" title="Give access to the real-time state of the mouse.">sf::Mouse</a></code> can retrieve the state of the cursor and the buttons 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 the mouse, even if it is moved, pressed or released when your window is out of focus and no event is triggered.</p>
<p>The <code>setPosition</code> and <code>getPosition</code> functions can be used to change or retrieve the current position of the mouse pointer. 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>Usage example: </p><div class="fragment"><div class="line"><span class="keywordflow">if</span> (<a class="code hl_function" href="#a2c04cfb3777a682cd83629ab0ba7443d">sf::Mouse::isButtonPressed</a>(<a class="code hl_enumvalue" href="#a4fb128be433f9aafe66bc0c605daaa90a945d5e233cf7d6240f6b783b36a374ff">sf::Mouse::Button::Left</a>))</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// left click...</span></div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// get global mouse position</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1Vector2.html">sf::Vector2i</a> position = <a class="code hl_function" href="#ad662f5ffc4b5b8c395be6a58d482b5fb">sf::Mouse::getPosition</a>();</div>
<div class="line"> </div>
<div class="line"><span class="comment">// set mouse position relative to a window</span></div>
<div class="line"><a class="code hl_function" href="#a6cf7dc4def89a2ae4e954fe0f454fed5">sf::Mouse::setPosition</a>(<a class="code hl_class" href="classsf_1_1Vector2.html">sf::Vector2i</a>(100, 200), 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_1Mouse_html_a2c04cfb3777a682cd83629ab0ba7443d"><div class="ttname"><a href="#a2c04cfb3777a682cd83629ab0ba7443d">sf::Mouse::isButtonPressed</a></div><div class="ttdeci">bool isButtonPressed(Button button)</div><div class="ttdoc">Check if a mouse button is pressed.</div></div>
<div class="ttc" id="anamespacesf_1_1Mouse_html_a4fb128be433f9aafe66bc0c605daaa90a945d5e233cf7d6240f6b783b36a374ff"><div class="ttname"><a href="#a4fb128be433f9aafe66bc0c605daaa90a945d5e233cf7d6240f6b783b36a374ff">sf::Mouse::Button::Left</a></div><div class="ttdeci">@ Left</div><div class="ttdoc">The left mouse button.</div></div>
<div class="ttc" id="anamespacesf_1_1Mouse_html_a6cf7dc4def89a2ae4e954fe0f454fed5"><div class="ttname"><a href="#a6cf7dc4def89a2ae4e954fe0f454fed5">sf::Mouse::setPosition</a></div><div class="ttdeci">void setPosition(Vector2i position)</div><div class="ttdoc">Set the current position of the mouse in desktop coordinates.</div></div>
<div class="ttc" id="anamespacesf_1_1Mouse_html_ad662f5ffc4b5b8c395be6a58d482b5fb"><div class="ttname"><a href="#ad662f5ffc4b5b8c395be6a58d482b5fb">sf::Mouse::getPosition</a></div><div class="ttdeci">Vector2i getPosition()</div><div class="ttdoc">Get the current position of the mouse 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_1Touch.html" title="Give access to the real-time state of the touches.">sf::Touch</a></code> </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a4fb128be433f9aafe66bc0c605daaa90" name="a4fb128be433f9aafe66bc0c605daaa90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fb128be433f9aafe66bc0c605daaa90">&#9670;&#160;</a></span>Button</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="#a4fb128be433f9aafe66bc0c605daaa90">sf::Mouse::Button</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><a class="el" href="namespacesf_1_1Mouse.html" title="Give access to the real-time state of the mouse.">Mouse</a> buttons. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4fb128be433f9aafe66bc0c605daaa90a945d5e233cf7d6240f6b783b36a374ff" name="a4fb128be433f9aafe66bc0c605daaa90a945d5e233cf7d6240f6b783b36a374ff"></a>Left&#160;</td><td class="fielddoc"><p>The left mouse button. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4fb128be433f9aafe66bc0c605daaa90a92b09c7c48c520c3c55e497875da437c" name="a4fb128be433f9aafe66bc0c605daaa90a92b09c7c48c520c3c55e497875da437c"></a>Right&#160;</td><td class="fielddoc"><p>The right mouse button. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4fb128be433f9aafe66bc0c605daaa90ab1ca34f82e83c52b010f86955f264e05" name="a4fb128be433f9aafe66bc0c605daaa90ab1ca34f82e83c52b010f86955f264e05"></a>Middle&#160;</td><td class="fielddoc"><p>The middle (wheel) mouse button. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4fb128be433f9aafe66bc0c605daaa90a113f84d105af2b8016b3896117c9deab" name="a4fb128be433f9aafe66bc0c605daaa90a113f84d105af2b8016b3896117c9deab"></a>Extra1&#160;</td><td class="fielddoc"><p>The first extra mouse button. </p>
</td></tr>
<tr><td class="fieldname"><a id="a4fb128be433f9aafe66bc0c605daaa90a83dca46dd08ad782e968d586375715e1" name="a4fb128be433f9aafe66bc0c605daaa90a83dca46dd08ad782e968d586375715e1"></a>Extra2&#160;</td><td class="fielddoc"><p>The second extra mouse button. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="Mouse_8hpp_source.html#l00049">49</a> of file <a class="el" href="Mouse_8hpp_source.html">Mouse.hpp</a>.</p>
</div>
</div>
<a id="a60dd479a43f26f200e7957aa11803ff4" name="a60dd479a43f26f200e7957aa11803ff4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60dd479a43f26f200e7957aa11803ff4">&#9670;&#160;</a></span>Wheel</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="#a60dd479a43f26f200e7957aa11803ff4">sf::Mouse::Wheel</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><a class="el" href="namespacesf_1_1Mouse.html" title="Give access to the real-time state of the mouse.">Mouse</a> wheels. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a60dd479a43f26f200e7957aa11803ff4a06ce2a25e5d12c166a36f654dbea6012" name="a60dd479a43f26f200e7957aa11803ff4a06ce2a25e5d12c166a36f654dbea6012"></a>Vertical&#160;</td><td class="fielddoc"><p>The vertical mouse wheel. </p>
</td></tr>
<tr><td class="fieldname"><a id="a60dd479a43f26f200e7957aa11803ff4ac1b5fa03ecdb95d4a45dd1c40b02527f" name="a60dd479a43f26f200e7957aa11803ff4ac1b5fa03ecdb95d4a45dd1c40b02527f"></a>Horizontal&#160;</td><td class="fielddoc"><p>The horizontal mouse wheel. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="Mouse_8hpp_source.html#l00065">65</a> of file <a class="el" href="Mouse_8hpp_source.html">Mouse.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad662f5ffc4b5b8c395be6a58d482b5fb" name="ad662f5ffc4b5b8c395be6a58d482b5fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad662f5ffc4b5b8c395be6a58d482b5fb">&#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::Mouse::getPosition </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 the mouse in desktop coordinates. </p>
<p>This function returns the global position of the mouse cursor on the desktop.</p>
<dl class="section return"><dt>Returns</dt><dd>Current position of the mouse </dd></dl>
</div>
</div>
<a id="a88e3e03774b60576ec48a2301f4f57f9" name="a88e3e03774b60576ec48a2301f4f57f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88e3e03774b60576ec48a2301f4f57f9">&#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::Mouse::getPosition </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></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 the mouse in window coordinates. </p>
<p>This function returns the current position of the mouse cursor, relative to the given window.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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 the mouse </dd></dl>
</div>
</div>
<a id="a2c04cfb3777a682cd83629ab0ba7443d" name="a2c04cfb3777a682cd83629ab0ba7443d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c04cfb3777a682cd83629ab0ba7443d">&#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::Mouse::isButtonPressed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90">Button</a></td> <td class="paramname"><span class="paramname"><em>button</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 mouse button is pressed. </p>
<dl class="section warning"><dt>Warning</dt><dd>Checking the state of buttons <code><a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90a113f84d105af2b8016b3896117c9deab" title="The first extra mouse button.">Mouse::Button::Extra1</a></code> and <code><a class="el" href="#a4fb128be433f9aafe66bc0c605daaa90a83dca46dd08ad782e968d586375715e1" title="The second extra mouse button.">Mouse::Button::Extra2</a></code> is not supported on Linux with X11.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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="a6cf7dc4def89a2ae4e954fe0f454fed5" name="a6cf7dc4def89a2ae4e954fe0f454fed5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cf7dc4def89a2ae4e954fe0f454fed5">&#9670;&#160;</a></span>setPosition() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Mouse::setPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a></td> <td class="paramname"><span class="paramname"><em>position</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the current position of the mouse in desktop coordinates. </p>
<p>This function sets the global position of the mouse cursor on the desktop.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>New position of the mouse </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aeaac27aac9cb5eeb26862550cbc3d583" name="aeaac27aac9cb5eeb26862550cbc3d583"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeaac27aac9cb5eeb26862550cbc3d583">&#9670;&#160;</a></span>setPosition() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Mouse::setPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a></td> <td class="paramname"><span class="paramname"><em>position</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>
</div><div class="memdoc">
<p>Set the current position of the mouse in window coordinates. </p>
<p>This function sets the current position of the mouse cursor, relative to the given window.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>New position of the mouse </td></tr>
<tr><td class="paramname">relativeTo</td><td>Reference window </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a78384824bc3b006a99ce61b1b04c37f7" name="a78384824bc3b006a99ce61b1b04c37f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78384824bc3b006a99ce61b1b04c37f7">&#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::Mouse::ButtonCount {5}</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>The total number of mouse buttons. </p>
<p class="definition">Definition at line <a class="el" href="Mouse_8hpp_source.html#l00059">59</a> of file <a class="el" href="Mouse_8hpp_source.html">Mouse.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