Sound.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
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_SOUND_H
26 #define SFML_SOUND_H
27 
29 // Headers
31 #include <SFML/Audio/Export.h>
32 #include <SFML/Audio/SoundStatus.h>
33 #include <SFML/Audio/Types.h>
34 #include <SFML/System/Time.h>
35 #include <SFML/System/Vector3.h>
36 
37 
45 
55 
63 
77 
88 
100 
112 CSFML_AUDIO_API void sfSound_setBuffer(sfSound* sound, const sfSoundBuffer* buffer);
113 
123 
136 CSFML_AUDIO_API void sfSound_setLoop(sfSound* sound, sfBool loop);
137 
147 
157 
171 CSFML_AUDIO_API void sfSound_setPitch(sfSound* sound, float pitch);
172 
183 CSFML_AUDIO_API void sfSound_setVolume(sfSound* sound, float volume);
184 
197 
212 
227 CSFML_AUDIO_API void sfSound_setMinDistance(sfSound* sound, float distance);
228 
245 CSFML_AUDIO_API void sfSound_setAttenuation(sfSound* sound, float attenuation);
246 
257 CSFML_AUDIO_API void sfSound_setPlayingOffset(sfSound* sound, sfTime timeOffset);
258 
267 CSFML_AUDIO_API float sfSound_getPitch(const sfSound* sound);
268 
277 CSFML_AUDIO_API float sfSound_getVolume(const sfSound* sound);
278 
288 
299 
309 
319 
329 
330 
331 #endif // SFML_SOUND_H
3-component vector of floats
Definition: Vector3.h:38
struct sfSoundBuffer sfSoundBuffer
Definition: Audio/Types.h:31
CSFML_AUDIO_API void sfSound_pause(sfSound *sound)
Pause a sound.
CSFML_AUDIO_API void sfSound_setRelativeToListener(sfSound *sound, sfBool relative)
Make the sound&#39;s position relative to the listener or absolute.
CSFML_AUDIO_API void sfSound_setPlayingOffset(sfSound *sound, sfTime timeOffset)
Change the current playing position of a sound.
CSFML_AUDIO_API void sfSound_setAttenuation(sfSound *sound, float attenuation)
Set the attenuation factor of a sound.
CSFML_AUDIO_API float sfSound_getAttenuation(const sfSound *sound)
Get the attenuation factor of a sound.
CSFML_AUDIO_API void sfSound_destroy(sfSound *sound)
Destroy a sound.
struct sfSound sfSound
Definition: Audio/Types.h:30
CSFML_AUDIO_API void sfSound_stop(sfSound *sound)
Stop playing a sound.
#define CSFML_AUDIO_API
Definition: Audio/Export.h:43
CSFML_AUDIO_API sfSound * sfSound_create(void)
Create a new sound.
CSFML_AUDIO_API sfTime sfSound_getPlayingOffset(const sfSound *sound)
Get the current playing position of a sound.
int sfBool
Definition: Config.h:153
sfSoundStatus
Enumeration of statuses for sounds and musics.
Definition: SoundStatus.h:38
CSFML_AUDIO_API void sfSound_setMinDistance(sfSound *sound, float distance)
Set the minimum distance of a sound.
CSFML_AUDIO_API sfSoundStatus sfSound_getStatus(const sfSound *sound)
Get the current status of a sound (stopped, paused, playing)
CSFML_AUDIO_API void sfSound_setBuffer(sfSound *sound, const sfSoundBuffer *buffer)
Set the source buffer containing the audio data to play.
Represents a time value.
Definition: Time.h:38
CSFML_AUDIO_API float sfSound_getPitch(const sfSound *sound)
Get the pitch of a sound.
CSFML_AUDIO_API sfBool sfSound_getLoop(const sfSound *sound)
Tell whether or not a sound is in loop mode.
CSFML_AUDIO_API float sfSound_getVolume(const sfSound *sound)
Get the volume of a sound.
CSFML_AUDIO_API void sfSound_setPitch(sfSound *sound, float pitch)
Set the pitch of a sound.
CSFML_AUDIO_API void sfSound_setLoop(sfSound *sound, sfBool loop)
Set whether or not a sound should loop after reaching the end.
CSFML_AUDIO_API void sfSound_setPosition(sfSound *sound, sfVector3f position)
Set the 3D position of a sound in the audio scene.
CSFML_AUDIO_API sfBool sfSound_isRelativeToListener(const sfSound *sound)
Tell whether a sound&#39;s position is relative to the listener or is absolute.
CSFML_AUDIO_API sfVector3f sfSound_getPosition(const sfSound *sound)
Get the 3D position of a sound in the audio scene.
CSFML_AUDIO_API float sfSound_getMinDistance(const sfSound *sound)
Get the minimum distance of a sound.
CSFML_AUDIO_API void sfSound_play(sfSound *sound)
Start or resume playing a sound.
CSFML_AUDIO_API sfSound * sfSound_copy(const sfSound *sound)
Create a new sound by copying an existing one.
CSFML_AUDIO_API const sfSoundBuffer * sfSound_getBuffer(const sfSound *sound)
Get the audio buffer attached to a sound.
CSFML_AUDIO_API void sfSound_setVolume(sfSound *sound, float volume)
Set the volume of a sound.