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