diff options
Diffstat (limited to 'doc/html/Sound_8hpp-source.htm')
| -rwxr-xr-x | doc/html/Sound_8hpp-source.htm | 117 |
1 files changed, 64 insertions, 53 deletions
diff --git a/doc/html/Sound_8hpp-source.htm b/doc/html/Sound_8hpp-source.htm index 568a401..4539489 100755 --- a/doc/html/Sound_8hpp-source.htm +++ b/doc/html/Sound_8hpp-source.htm @@ -10,19 +10,25 @@ <div id="logo"> <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> </div> -<!-- Generated by Doxygen 1.5.2 --> -<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><a href="classes.htm"><span>Classes</span></a></li> - <li class="current"><a href="files.htm"><span>Files</span></a></li> - </ul> -</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><a href="annotated.htm"><span>Classes</span></a></li> + <li class="current"><a href="files.htm"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.htm"><span>File List</span></a></li> + </ul> + </div> <h1>Sound.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <a name="l00002"></a>00002 <span class="comment">//</span> <a name="l00003"></a>00003 <span class="comment">// SFML - Simple and Fast Multimedia Library</span> -<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007-2008 Laurent Gomila (laurent.gom@gmail.com)</span> +<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)</span> <a name="l00005"></a>00005 <span class="comment">//</span> <a name="l00006"></a>00006 <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span> <a name="l00007"></a>00007 <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span> @@ -56,7 +62,7 @@ <a name="l00038"></a>00038 { <a name="l00039"></a>00039 <span class="keyword">class </span>SoundBuffer; <a name="l00040"></a>00040 -<a name="l00045"></a><a class="code" href="classsf_1_1Sound.htm">00045</a> <span class="keyword">class </span>SFML_API Sound : <span class="keyword">public</span> <a class="code" href="classsf_1_1AudioResource.htm" title="Abstract base class for every class that owns a device-dependant resource -- allow...">AudioResource</a> +<a name="l00045"></a><a class="code" href="classsf_1_1Sound.htm">00045</a> <span class="keyword">class </span>SFML_API <a class="code" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a> : <span class="keyword">public</span> <a class="code" href="classsf_1_1AudioResource.htm" title="Abstract base class for every class that owns a device-dependant resource -- allow...">AudioResource</a> <a name="l00046"></a>00046 { <a name="l00047"></a>00047 <span class="keyword">public</span> : <a name="l00048"></a>00048 @@ -67,13 +73,13 @@ <a name="l00056"></a><a class="code" href="classsf_1_1Sound.htm#28ad2186cde78fed2c79c867b962219516657b221888cf11e2a076f5b2783288">00056</a> Playing <a name="l00057"></a>00057 }; <a name="l00058"></a>00058 -<a name="l00063"></a>00063 Sound(); +<a name="l00063"></a>00063 <a class="code" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a>(); <a name="l00064"></a>00064 -<a name="l00075"></a>00075 Sound(<span class="keyword">const</span> <a class="code" href="classsf_1_1SoundBuffer.htm" title="SoundBuffer is the low-level for loading and manipulating sound buffers.">SoundBuffer</a>& Buffer, <span class="keywordtype">bool</span> Loop = <span class="keyword">false</span>, <span class="keywordtype">float</span> Pitch = 1.f, <span class="keywordtype">float</span> Volume = 100.f, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3f</a>& Position = <a class="code" href="namespacesf.htm#f97357d7d32e7d6a700d03be2f3b4811">Vector3f</a>(0, 0, 0)); +<a name="l00075"></a>00075 <a class="code" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1SoundBuffer.htm" title="SoundBuffer is the low-level for loading and manipulating sound buffers.">SoundBuffer</a>& Buffer, <span class="keywordtype">bool</span> Loop = <span class="keyword">false</span>, <span class="keywordtype">float</span> Pitch = 1.f, <span class="keywordtype">float</span> Volume = 100.f, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3f</a>& Position = <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3f</a>(0, 0, 0)); <a name="l00076"></a>00076 -<a name="l00083"></a>00083 Sound(<span class="keyword">const</span> Sound& Copy); +<a name="l00083"></a>00083 <a class="code" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a>& Copy); <a name="l00084"></a>00084 -<a name="l00089"></a>00089 ~Sound(); +<a name="l00089"></a>00089 ~<a class="code" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a>(); <a name="l00090"></a>00090 <a name="l00095"></a>00095 <span class="keywordtype">void</span> Play(); <a name="l00096"></a>00096 @@ -93,46 +99,51 @@ <a name="l00152"></a>00152 <a name="l00160"></a>00160 <span class="keywordtype">void</span> SetPosition(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3f</a>& Position); <a name="l00161"></a>00161 -<a name="l00170"></a>00170 <span class="keywordtype">void</span> SetMinDistance(<span class="keywordtype">float</span> MinDistance); +<a name="l00170"></a>00170 <span class="keywordtype">void</span> SetRelativeToListener(<span class="keywordtype">bool</span> Relative); <a name="l00171"></a>00171 -<a name="l00180"></a>00180 <span class="keywordtype">void</span> SetAttenuation(<span class="keywordtype">float</span> Attenuation); +<a name="l00180"></a>00180 <span class="keywordtype">void</span> SetMinDistance(<span class="keywordtype">float</span> MinDistance); <a name="l00181"></a>00181 -<a name="l00188"></a>00188 <span class="keywordtype">void</span> SetPlayingOffset(<span class="keywordtype">float</span> TimeOffset); -<a name="l00189"></a>00189 -<a name="l00196"></a>00196 <span class="keyword">const</span> <a class="code" href="classsf_1_1SoundBuffer.htm" title="SoundBuffer is the low-level for loading and manipulating sound buffers.">SoundBuffer</a>* GetBuffer() <span class="keyword">const</span>; -<a name="l00197"></a>00197 -<a name="l00204"></a>00204 <span class="keywordtype">bool</span> GetLoop() <span class="keyword">const</span>; -<a name="l00205"></a>00205 -<a name="l00212"></a>00212 <span class="keywordtype">float</span> GetPitch() <span class="keyword">const</span>; -<a name="l00213"></a>00213 -<a name="l00220"></a>00220 <span class="keywordtype">float</span> GetVolume() <span class="keyword">const</span>; -<a name="l00221"></a>00221 -<a name="l00228"></a>00228 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3f</a> GetPosition() <span class="keyword">const</span>; -<a name="l00229"></a>00229 -<a name="l00236"></a>00236 <span class="keywordtype">float</span> GetMinDistance() <span class="keyword">const</span>; -<a name="l00237"></a>00237 -<a name="l00244"></a>00244 <span class="keywordtype">float</span> GetAttenuation() <span class="keyword">const</span>; -<a name="l00245"></a>00245 -<a name="l00252"></a>00252 Status GetStatus() <span class="keyword">const</span>; -<a name="l00253"></a>00253 -<a name="l00260"></a>00260 <span class="keywordtype">float</span> GetPlayingOffset() <span class="keyword">const</span>; -<a name="l00261"></a>00261 -<a name="l00270"></a>00270 Sound& operator =(<span class="keyword">const</span> Sound& Other); -<a name="l00271"></a>00271 -<a name="l00272"></a>00272 <span class="keyword">private</span> : -<a name="l00273"></a>00273 -<a name="l00274"></a><a class="code" href="classsf_1_1Sound.htm#22d0a4fe764bba1f30b58224b1f8855e">00274</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classsf_1_1SoundStream.htm" title="SoundStream is a streamed sound, ie samples are acquired while the sound is playing...">SoundStream</a>; -<a name="l00275"></a>00275 -<a name="l00277"></a>00277 <span class="comment">// Member data</span> -<a name="l00279"></a>00279 <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mySource; -<a name="l00280"></a>00280 <a class="code" href="classsf_1_1ResourcePtr.htm" title="Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically...">ResourcePtr<SoundBuffer></a> myBuffer; -<a name="l00281"></a>00281 }; -<a name="l00282"></a>00282 -<a name="l00283"></a>00283 } <span class="comment">// namespace sf</span> -<a name="l00284"></a>00284 -<a name="l00285"></a>00285 -<a name="l00286"></a>00286 <span class="preprocessor">#endif // SFML_SOUND_HPP</span> -</pre></div> +<a name="l00190"></a>00190 <span class="keywordtype">void</span> SetAttenuation(<span class="keywordtype">float</span> Attenuation); +<a name="l00191"></a>00191 +<a name="l00198"></a>00198 <span class="keywordtype">void</span> SetPlayingOffset(<span class="keywordtype">float</span> TimeOffset); +<a name="l00199"></a>00199 +<a name="l00206"></a>00206 <span class="keyword">const</span> <a class="code" href="classsf_1_1SoundBuffer.htm" title="SoundBuffer is the low-level for loading and manipulating sound buffers.">SoundBuffer</a>* GetBuffer() <span class="keyword">const</span>; +<a name="l00207"></a>00207 +<a name="l00214"></a>00214 <span class="keywordtype">bool</span> GetLoop() <span class="keyword">const</span>; +<a name="l00215"></a>00215 +<a name="l00222"></a>00222 <span class="keywordtype">float</span> GetPitch() <span class="keyword">const</span>; +<a name="l00223"></a>00223 +<a name="l00230"></a>00230 <span class="keywordtype">float</span> GetVolume() <span class="keyword">const</span>; +<a name="l00231"></a>00231 +<a name="l00238"></a>00238 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3f</a> GetPosition() <span class="keyword">const</span>; +<a name="l00239"></a>00239 +<a name="l00247"></a>00247 <span class="keywordtype">bool</span> IsRelativeToListener() <span class="keyword">const</span>; +<a name="l00248"></a>00248 +<a name="l00255"></a>00255 <span class="keywordtype">float</span> GetMinDistance() <span class="keyword">const</span>; +<a name="l00256"></a>00256 +<a name="l00263"></a>00263 <span class="keywordtype">float</span> GetAttenuation() <span class="keyword">const</span>; +<a name="l00264"></a>00264 +<a name="l00271"></a>00271 Status GetStatus() <span class="keyword">const</span>; +<a name="l00272"></a>00272 +<a name="l00279"></a>00279 <span class="keywordtype">float</span> GetPlayingOffset() <span class="keyword">const</span>; +<a name="l00280"></a>00280 +<a name="l00289"></a>00289 <a class="code" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a>& operator =(<span class="keyword">const</span> <a class="code" href="classsf_1_1Sound.htm" title="Sound defines the properties of a sound such as position, volume, pitch, etc.">Sound</a>& Other); +<a name="l00290"></a>00290 +<a name="l00291"></a>00291 <span class="keyword">private</span> : +<a name="l00292"></a>00292 +<a name="l00293"></a>00293 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classsf_1_1SoundStream.htm" title="SoundStream is a streamed sound, ie samples are acquired while the sound is playing...">SoundStream</a>; +<a name="l00294"></a>00294 +<a name="l00296"></a>00296 <span class="comment">// Member data</span> +<a name="l00298"></a>00298 <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mySource; +<a name="l00299"></a>00299 <a class="code" href="classsf_1_1ResourcePtr.htm">ResourcePtr<SoundBuffer></a> myBuffer; +<a name="l00300"></a>00300 }; +<a name="l00301"></a>00301 +<a name="l00302"></a>00302 } <span class="comment">// namespace sf</span> +<a name="l00303"></a>00303 +<a name="l00304"></a>00304 +<a name="l00305"></a>00305 <span class="preprocessor">#endif // SFML_SOUND_HPP</span> +</pre></div></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> :: |