#include <Sound.hpp>
Inheritance diagram for sf::Sound:
Public Types | |
enum | Status { Stopped, Paused, Playing } |
Enumeration of the sound states. More... | |
Public Member Functions | |
Sound () | |
Default constructor. | |
Sound (const SoundBuffer &Buffer, bool Loop=false, float Pitch=1.f, float Volume=100.f, const Vector3f &Position=Vector3f(0, 0, 0)) | |
Construct the sound from its parameters. | |
Sound (const Sound &Copy) | |
Copy constructor. | |
~Sound () | |
Destructor. | |
void | Play () |
Play the sound. | |
void | Pause () |
Pause the sound. | |
void | Stop () |
Stop the sound. | |
void | SetBuffer (const SoundBuffer &Buffer) |
Set the source buffer. | |
void | SetLoop (bool Loop) |
Set the sound loop state. | |
void | SetPitch (float Pitch) |
Set the sound pitch. | |
void | SetVolume (float Volume) |
Set the sound volume. | |
void | SetPosition (float X, float Y, float Z) |
Set the sound position (take 3 values). | |
void | SetPosition (const Vector3f &Position) |
Set the sound position (take a 3D vector). | |
void | SetMinDistance (float MinDistance) |
Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume. | |
void | SetAttenuation (float Attenuation) |
Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener. | |
void | SetPlayingOffset (float TimeOffset) |
Set the current playing position of the sound. | |
const SoundBuffer * | GetBuffer () const |
Get the source buffer. | |
bool | GetLoop () const |
Tell whether or not the sound is looping. | |
float | GetPitch () const |
Get the pitch. | |
float | GetVolume () const |
Get the volume. | |
Vector3f | GetPosition () const |
Get the sound position. | |
float | GetMinDistance () const |
Get the minimum distance. | |
float | GetAttenuation () const |
Get the attenuation factor. | |
Status | GetStatus () const |
Get the status of the sound (stopped, paused, playing). | |
float | GetPlayingOffset () const |
Get the current playing position of the sound. | |
Sound & | operator= (const Sound &Other) |
Assignment operator. | |
Friends | |
class | SoundStream |
Definition at line 45 of file Sound.hpp.
enum sf::Sound::Status |
sf::Sound::Sound | ( | ) |
Default constructor.
sf::Sound::Sound | ( | const SoundBuffer & | Buffer, | |
bool | Loop = false , |
|||
float | Pitch = 1.f , |
|||
float | Volume = 100.f , |
|||
const Vector3f & | Position = Vector3f(0, 0, 0) | |||
) |
Construct the sound from its parameters.
Buffer | : Sound buffer to play (NULL by default) | |
Loop | : Loop flag (false by default) | |
Pitch | : Value of the pitch (1 by default) | |
Volume | : Volume (100 by default) | |
Position | : Position (0, 0, 0 by default) |
sf::Sound::Sound | ( | const Sound & | Copy | ) |
Copy constructor.
Copy | : Instance to copy |
sf::Sound::~Sound | ( | ) |
Destructor.
void sf::Sound::Play | ( | ) |
void sf::Sound::Pause | ( | ) |
Pause the sound.
void sf::Sound::Stop | ( | ) |
void sf::Sound::SetBuffer | ( | const SoundBuffer & | Buffer | ) |
Set the source buffer.
Buffer | : New sound buffer to bind to the sound |
void sf::Sound::SetLoop | ( | bool | Loop | ) |
Set the sound loop state.
This parameter is disabled by default
Loop | : True to play in loop, false to play once |
Reimplemented in sf::SoundStream.
void sf::Sound::SetPitch | ( | float | Pitch | ) |
Set the sound pitch.
The default pitch is 1
Pitch | : New pitch |
void sf::Sound::SetVolume | ( | float | Volume | ) |
Set the sound volume.
The default volume is 100
Volume | : Volume (in range [0, 100]) |
void sf::Sound::SetPosition | ( | float | X, | |
float | Y, | |||
float | Z | |||
) |
Set the sound position (take 3 values).
The default position is (0, 0, 0)
X,Y,Z | : Position of the sound in the world |
void sf::Sound::SetPosition | ( | const Vector3f & | Position | ) |
Set the sound position (take a 3D vector).
The default position is (0, 0, 0)
Position | : Position of the sound in the world |
void sf::Sound::SetMinDistance | ( | float | MinDistance | ) |
Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume.
The default minimum distance is 1.0
MinDistance | : New minimum distance for the sound |
void sf::Sound::SetAttenuation | ( | float | Attenuation | ) |
Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener.
The default attenuation factor 1.0
Attenuation | : New attenuation factor for the sound |
void sf::Sound::SetPlayingOffset | ( | float | TimeOffset | ) |
Set the current playing position of the sound.
TimeOffset | : New playing position, expressed in seconds |
const SoundBuffer* sf::Sound::GetBuffer | ( | ) | const |
bool sf::Sound::GetLoop | ( | ) | const |
Tell whether or not the sound is looping.
Reimplemented in sf::SoundStream.
float sf::Sound::GetPitch | ( | ) | const |
Get the pitch.
float sf::Sound::GetVolume | ( | ) | const |
Get the volume.
Vector3f sf::Sound::GetPosition | ( | ) | const |
Get the sound position.
float sf::Sound::GetMinDistance | ( | ) | const |
Get the minimum distance.
float sf::Sound::GetAttenuation | ( | ) | const |
Get the attenuation factor.
Status sf::Sound::GetStatus | ( | ) | const |
Get the status of the sound (stopped, paused, playing).
Reimplemented in sf::SoundStream.
float sf::Sound::GetPlayingOffset | ( | ) | const |
Get the current playing position of the sound.
Reimplemented in sf::SoundStream.
Assignment operator.
Other | : Instance to assign |