1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<!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>CSFML - C binding of the 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="http://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
<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">CSFML</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="annotated.htm"><span>Data Structures</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>
<li><a href="globals.htm"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a66b7969672f1da69f458a57d2c97f9.htm">include</a></li><li class="navelem"><a class="el" href="dir_8cc999c03ab8fdf40558b1f21f869c3e.htm">SFML</a></li><li class="navelem"><a class="el" href="dir_ec1eadea4ddc9b364e33c863bb96372e.htm">Window</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Mouse.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="Window_2Export_8h_source.htm">SFML/Window/Export.h</a>></code><br/>
<code>#include <<a class="el" href="Window_2Types_8h_source.htm">SFML/Window/Types.h</a>></code><br/>
<code>#include <<a class="el" href="Vector2_8h_source.htm">SFML/System/Vector2.h</a>></code><br/>
</div>
<p><a href="Mouse_8h_source.htm">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ae63e057df142c5192f3bfdf34fcff699"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699">sfMouseButton</a> { <br/>
  <a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699ade2d927feaea6c268ce86b5bca032dfe">sfMouseLeft</a>,
<br/>
  <a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699a7742137d4f8c8f63c94a0c20922426ef">sfMouseRight</a>,
<br/>
  <a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699ab05d04dd19061d981380c9a5af1f0784">sfMouseMiddle</a>,
<br/>
  <a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699a0be97f67a01099181f57c704f700c205">sfMouseXButton1</a>,
<br/>
  <a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699a1c77d65e6d8377f2440362fffc64fdc3">sfMouseXButton2</a>,
<br/>
  <a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699aa39a404ee26a7a0bcf625cec911dc506">sfMouseButtonCount</a>
<br/>
}</td></tr>
<tr class="memdesc:ae63e057df142c5192f3bfdf34fcff699"><td class="mdescLeft"> </td><td class="mdescRight">Mouse buttons. <a href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699">More...</a><br/></td></tr>
<tr class="separator:ae63e057df142c5192f3bfdf34fcff699"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae9f7ab4ed71af9b8078e0cfa68b0e236"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Window_2Export_8h.htm#a2a95377e5ef218e2ae20060811a37b26">CSFML_WINDOW_API</a> <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="Mouse_8h.htm#ae9f7ab4ed71af9b8078e0cfa68b0e236">sfMouse_isButtonPressed</a> (<a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699">sfMouseButton</a> button)</td></tr>
<tr class="memdesc:ae9f7ab4ed71af9b8078e0cfa68b0e236"><td class="mdescLeft"> </td><td class="mdescRight">Check if a mouse button is pressed. <a href="#ae9f7ab4ed71af9b8078e0cfa68b0e236"></a><br/></td></tr>
<tr class="separator:ae9f7ab4ed71af9b8078e0cfa68b0e236"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4a2e0195bfa6ffbab2d4e5f04c43040"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Window_2Export_8h.htm#a2a95377e5ef218e2ae20060811a37b26">CSFML_WINDOW_API</a> <a class="el" href="structsfVector2i.htm">sfVector2i</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="Mouse_8h.htm#ae4a2e0195bfa6ffbab2d4e5f04c43040">sfMouse_getPosition</a> (const <a class="el" href="Window_2Types_8h.htm#a6f35847172308743f3fa10d84535ae8e">sfWindow</a> *relativeTo)</td></tr>
<tr class="memdesc:ae4a2e0195bfa6ffbab2d4e5f04c43040"><td class="mdescLeft"> </td><td class="mdescRight">Get the current position of the mouse. <a href="#ae4a2e0195bfa6ffbab2d4e5f04c43040"></a><br/></td></tr>
<tr class="separator:ae4a2e0195bfa6ffbab2d4e5f04c43040"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7cffa8f73caa669b2dc683e9cc106d52"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Window_2Export_8h.htm#a2a95377e5ef218e2ae20060811a37b26">CSFML_WINDOW_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="Mouse_8h.htm#a7cffa8f73caa669b2dc683e9cc106d52">sfMouse_setPosition</a> (<a class="el" href="structsfVector2i.htm">sfVector2i</a> position, const <a class="el" href="Window_2Types_8h.htm#a6f35847172308743f3fa10d84535ae8e">sfWindow</a> *relativeTo)</td></tr>
<tr class="memdesc:a7cffa8f73caa669b2dc683e9cc106d52"><td class="mdescLeft"> </td><td class="mdescRight">Set the current position of the mouse. <a href="#a7cffa8f73caa669b2dc683e9cc106d52"></a><br/></td></tr>
<tr class="separator:a7cffa8f73caa669b2dc683e9cc106d52"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ae63e057df142c5192f3bfdf34fcff699"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699">sfMouseButton</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mouse buttons. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ae63e057df142c5192f3bfdf34fcff699ade2d927feaea6c268ce86b5bca032dfe"></a>sfMouseLeft</em> </td><td>
<p>The left mouse button. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae63e057df142c5192f3bfdf34fcff699a7742137d4f8c8f63c94a0c20922426ef"></a>sfMouseRight</em> </td><td>
<p>The right mouse button. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae63e057df142c5192f3bfdf34fcff699ab05d04dd19061d981380c9a5af1f0784"></a>sfMouseMiddle</em> </td><td>
<p>The middle (wheel) mouse button. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae63e057df142c5192f3bfdf34fcff699a0be97f67a01099181f57c704f700c205"></a>sfMouseXButton1</em> </td><td>
<p>The first extra mouse button. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae63e057df142c5192f3bfdf34fcff699a1c77d65e6d8377f2440362fffc64fdc3"></a>sfMouseXButton2</em> </td><td>
<p>The second extra mouse button. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae63e057df142c5192f3bfdf34fcff699aa39a404ee26a7a0bcf625cec911dc506"></a>sfMouseButtonCount</em> </td><td>
<p>Keep last – the total number of mouse buttons. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="Mouse_8h_source.htm#l00039">39</a> of file <a class="el" href="Mouse_8h_source.htm">Mouse.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ae4a2e0195bfa6ffbab2d4e5f04c43040"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Window_2Export_8h.htm#a2a95377e5ef218e2ae20060811a37b26">CSFML_WINDOW_API</a> <a class="el" href="structsfVector2i.htm">sfVector2i</a> sfMouse_getPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Window_2Types_8h.htm#a6f35847172308743f3fa10d84535ae8e">sfWindow</a> * </td>
<td class="paramname"><em>relativeTo</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current position of the mouse. </p>
<p>This function returns the current position of the mouse cursor relative to the given window, or desktop if NULL is passed.</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>Position of the mouse cursor, relative to the given window </dd></dl>
</div>
</div>
<a class="anchor" id="ae9f7ab4ed71af9b8078e0cfa68b0e236"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Window_2Export_8h.htm#a2a95377e5ef218e2ae20060811a37b26">CSFML_WINDOW_API</a> <a class="el" href="Config_8h.htm#a7559f07a31bb3a4a3d865178ce4dc70b">sfBool</a> sfMouse_isButtonPressed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Mouse_8h.htm#ae63e057df142c5192f3bfdf34fcff699">sfMouseButton</a> </td>
<td class="paramname"><em>button</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a mouse button is pressed. </p>
<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>sfTrue if the button is pressed, sfFalse otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="a7cffa8f73caa669b2dc683e9cc106d52"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="Window_2Export_8h.htm#a2a95377e5ef218e2ae20060811a37b26">CSFML_WINDOW_API</a> void sfMouse_setPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structsfVector2i.htm">sfVector2i</a> </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="Window_2Types_8h.htm#a6f35847172308743f3fa10d84535ae8e">sfWindow</a> * </td>
<td class="paramname"><em>relativeTo</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the current position of the mouse. </p>
<p>This function sets the current position of the mouse cursor relative to the given window, or desktop if NULL is passed.</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>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
Copyright � Laurent Gomila ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
</div>
</div>
</body>
</html>
|