Documentation of SFML 2.2

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
SoundSource.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2014 Laurent Gomila (laurent.gom@gmail.com)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_SOUNDSOURCE_HPP
26 #define SFML_SOUNDSOURCE_HPP
27 
29 // Headers
31 #include <SFML/Audio/Export.hpp>
32 #include <SFML/System/Vector3.hpp>
33 
34 
35 namespace sf
36 {
41 class SFML_AUDIO_API SoundSource
42 {
43 public:
44 
49  enum Status
50  {
53  Playing
54  };
55 
62  SoundSource(const SoundSource& copy);
63 
68  virtual ~SoundSource();
69 
84  void setPitch(float pitch);
85 
97  void setVolume(float volume);
98 
113  void setPosition(float x, float y, float z);
114 
127  void setPosition(const Vector3f& position);
128 
143  void setRelativeToListener(bool relative);
144 
160  void setMinDistance(float distance);
161 
179  void setAttenuation(float attenuation);
180 
189  float getPitch() const;
190 
199  float getVolume() const;
200 
209  Vector3f getPosition() const;
210 
220  bool isRelativeToListener() const;
221 
230  float getMinDistance() const;
231 
240  float getAttenuation() const;
241 
242 protected:
243 
250  SoundSource();
251 
258  Status getStatus() const;
259 
261  // Member data
263  unsigned int m_source;
264 };
265 
266 } // namespace sf
267 
268 
269 #endif // SFML_SOUNDSOURCE_HPP
270 
271 
Definition: Listener.hpp:35
unsigned int m_source
OpenAL source identifier.
Status
Enumeration of the sound source states.
Definition: SoundSource.hpp:49
Base class defining a sound's properties.
Definition: SoundSource.hpp:41
Sound is paused.
Definition: SoundSource.hpp:52
Sound is not playing.
Definition: SoundSource.hpp:51
Utility template class for manipulating 3-dimensional vectors.
Definition: Vector3.hpp:37