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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="tabs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="logo">
<img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="namespaces.htm"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.htm"><span>Classes</span></a></li>
<li><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.htm"><span>Class List</span></a></li>
<li><a href="classes.htm"><span>Class Index</span></a></li>
<li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1Listener.htm">Listener</a>
</div>
</div>
<div class="contents">
<h1>sf::Listener Class Reference</h1><!-- doxytag: class="sf::Listener" --><a class="el" href="classsf_1_1Listener.htm" title="Listener is a global interface for defining the audio listener properties ; the audio...">Listener</a> is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Listener_8hpp-source.htm">Listener.hpp</a>></code>
<p>
<p>
<a href="classsf_1_1Listener-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#0f8f05ffede8dd5f075fa120c41bec84">SetGlobalVolume</a> (float Volume)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the global volume of all the sounds. <a href="#0f8f05ffede8dd5f075fa120c41bec84"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#eaffa5db15e6e790a4c20e014a8cfa19">GetGlobalVolume</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current value of the global volume of all the sounds. <a href="#eaffa5db15e6e790a4c20e014a8cfa19"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#c54f7441ee2511079df71c1107242b48">SetPosition</a> (float X, float Y, float Z)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the position of the listener (take 3 values). <a href="#c54f7441ee2511079df71c1107242b48"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#e461aa59bf5aa43eb3e1fcf7cb2dbfd0">SetPosition</a> (const <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> &Position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the position of the listener (take a 3D vector). <a href="#e461aa59bf5aa43eb3e1fcf7cb2dbfd0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#c36493661fa0784df73e6efc429bb251">GetPosition</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current position of the listener. <a href="#c36493661fa0784df73e6efc429bb251"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#4638a9c80c9a2027e93b44acdc48a8bf">SetTarget</a> (float X, float Y, float Z)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the orientation of the listener (the point he must look at) (take 3 values). <a href="#4638a9c80c9a2027e93b44acdc48a8bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#e8191c90eb8d96e8d3cc578850c91b02">SetTarget</a> (const <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> &Target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the orientation of the listener (the point he must look at) (take a 3D vector). <a href="#e8191c90eb8d96e8d3cc578850c91b02"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#322a2f7a68893559c40e3ab2a324293a">GetTarget</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current orientation of the listener (the point he's looking at). <a href="#322a2f7a68893559c40e3ab2a324293a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classsf_1_1Listener.htm" title="Listener is a global interface for defining the audio listener properties ; the audio...">Listener</a> is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard.
<p>Definition at line <a class="el" href="Listener_8hpp-source.htm#l00042">42</a> of file <a class="el" href="Listener_8hpp-source.htm">Listener.hpp</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="eaffa5db15e6e790a4c20e014a8cfa19"></a><!-- doxytag: member="sf::Listener::GetGlobalVolume" ref="eaffa5db15e6e790a4c20e014a8cfa19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float sf::Listener::GetGlobalVolume </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current value of the global volume of all the sounds.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current global volume, in the range [0, 100] </dd></dl>
<p>Definition at line <a class="el" href="Listener_8cpp-source.htm#l00046">46</a> of file <a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c36493661fa0784df73e6efc429bb251"></a><!-- doxytag: member="sf::Listener::GetPosition" ref="c36493661fa0784df73e6efc429bb251" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> sf::Listener::GetPosition </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current position of the listener.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Position of the listener in the world </dd></dl>
<p>Definition at line <a class="el" href="Listener_8cpp-source.htm#l00076">76</a> of file <a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="322a2f7a68893559c40e3ab2a324293a"></a><!-- doxytag: member="sf::Listener::GetTarget" ref="322a2f7a68893559c40e3ab2a324293a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> sf::Listener::GetTarget </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current orientation of the listener (the point he's looking at).
<p>
Get the current orientation of the listener (the point he's looking at).<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: Position of the point the listener is looking at </dd></dl>
<p>Definition at line <a class="el" href="Listener_8cpp-source.htm#l00110">110</a> of file <a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0f8f05ffede8dd5f075fa120c41bec84"></a><!-- doxytag: member="sf::Listener::SetGlobalVolume" ref="0f8f05ffede8dd5f075fa120c41bec84" args="(float Volume)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Listener::SetGlobalVolume </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>Volume</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the global volume of all the sounds.
<p>
The default volume is 100<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Volume</em> </td><td>: New global volume, in the range [0, 100] </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Listener_8cpp-source.htm#l00037">37</a> of file <a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="e461aa59bf5aa43eb3e1fcf7cb2dbfd0"></a><!-- doxytag: member="sf::Listener::SetPosition" ref="e461aa59bf5aa43eb3e1fcf7cb2dbfd0" args="(const Vector3f &Position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Listener::SetPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> & </td>
<td class="paramname"> <em>Position</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the position of the listener (take a 3D vector).
<p>
The default position is (0, 0, 0)<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Position</em> </td><td>: Position of the listener in the world </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Listener_8cpp-source.htm#l00067">67</a> of file <a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c54f7441ee2511079df71c1107242b48"></a><!-- doxytag: member="sf::Listener::SetPosition" ref="c54f7441ee2511079df71c1107242b48" args="(float X, float Y, float Z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Listener::SetPosition </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>X</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>Y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>Z</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the position of the listener (take 3 values).
<p>
The default position is (0, 0, 0)<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>X,Y,Z</em> </td><td>: Position of the listener in the world </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Listener_8cpp-source.htm#l00058">58</a> of file <a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="e8191c90eb8d96e8d3cc578850c91b02"></a><!-- doxytag: member="sf::Listener::SetTarget" ref="e8191c90eb8d96e8d3cc578850c91b02" args="(const Vector3f &Target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Listener::SetTarget </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> & </td>
<td class="paramname"> <em>Target</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the orientation of the listener (the point he must look at) (take a 3D vector).
<p>
Change the orientation of the listener (the point he must look at) (take a 3D vector).<p>
The default target is (0, 0, -1)<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Target</em> </td><td>: Position of the point the listener must look at </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Listener_8cpp-source.htm#l00100">100</a> of file <a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="4638a9c80c9a2027e93b44acdc48a8bf"></a><!-- doxytag: member="sf::Listener::SetTarget" ref="4638a9c80c9a2027e93b44acdc48a8bf" args="(float X, float Y, float Z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Listener::SetTarget </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>X</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>Y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>Z</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the orientation of the listener (the point he must look at) (take 3 values).
<p>
Change the orientation of the listener (the point he must look at) (take 3 values).<p>
The default target is (0, 0, -1)<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>X,Y,Z</em> </td><td>: Position of the point the listener must look at </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="Listener_8cpp-source.htm#l00089">89</a> of file <a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Listener_8hpp-source.htm">Listener.hpp</a><li><a class="el" href="Listener_8cpp-source.htm">Listener.cpp</a></ul>
</div>
<p id="footer">
:: Copyright © 2007-2008 Laurent Gomila, all rights reserved ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> ::
</p>
</body>
</html>
|
