CSFML - C binding of the Simple and Fast Multimedia Library

CSFML

- Main Page
- Related Pages
- Classes
- Files

- File List
- File Members

Sound.h
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2018 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
44 CSFML_AUDIO_API sfSound* sfSound_create(void);
45
54 CSFML_AUDIO_API sfSound* sfSound_copy(const sfSound* sound);
55
62 CSFML_AUDIO_API void sfSound_destroy(sfSound* sound);
63
76 CSFML_AUDIO_API void sfSound_play(sfSound* sound);
77
87 CSFML_AUDIO_API void sfSound_pause(sfSound* sound);
88
99 CSFML_AUDIO_API void sfSound_stop(sfSound* sound);
100
112 CSFML_AUDIO_API void sfSound_setBuffer(sfSound* sound, const sfSoundBuffer* buffer);
113
122 CSFML_AUDIO_API const sfSoundBuffer* sfSound_getBuffer(const sfSound* sound);
123
136 CSFML_AUDIO_API void sfSound_setLoop(sfSound* sound, sfBool loop);
137
146 CSFML_AUDIO_API sfBool sfSound_getLoop(const sfSound* sound);
147
156 CSFML_AUDIO_API sfSoundStatus sfSound_getStatus(const sfSound* sound);
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
196 CSFML_AUDIO_API void sfSound_setPosition(sfSound* sound, sfVector3f position);
197
211 CSFML_AUDIO_API void sfSound_setRelativeToListener(sfSound* sound, sfBool relative);
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
287 CSFML_AUDIO_API sfVector3f sfSound_getPosition(const sfSound* sound);
288
298 CSFML_AUDIO_API sfBool sfSound_isRelativeToListener(const sfSound* sound);
299
308 CSFML_AUDIO_API float sfSound_getMinDistance(const sfSound* sound);
309
318 CSFML_AUDIO_API float sfSound_getAttenuation(const sfSound* sound);
319
328 CSFML_AUDIO_API sfTime sfSound_getPlayingOffset(const sfSound* sound);
329
330
331 #endif // SFML_SOUND_H
sfTime
Represents a time value.
Definition: Time.h:39
sfVector3f
3-component vector of floats
Definition: Vector3.h:39