#include <SFML/Config.h>
#include <SFML/Audio/SoundBuffer.h>
#include <SFML/Audio/SoundStatus.h>
Go to the source code of this file.
Typedefs | |
typedef sfSound | sfSound |
sfSound defines the properties of the sound such as position, volume, pitch, etc. | |
Functions | |
CSFML_API sfSound * | sfSound_Create () |
Construct a new sound. | |
CSFML_API void | sfSound_Destroy (sfSound *Sound) |
Destroy an existing sound. | |
CSFML_API void | sfSound_Play (sfSound *Sound) |
Start playing a sound. | |
CSFML_API void | sfSound_Pause (sfSound *Sound) |
Pause a sound. | |
CSFML_API void | sfSound_Stop (sfSound *Sound) |
Stop playing a sound. | |
CSFML_API void | sfSound_SetBuffer (sfSound *Sound, sfSoundBuffer *Buffer) |
Bind a sound buffer to a sound. | |
CSFML_API sfSoundBuffer * | sfSound_GetBuffer (sfSound *Sound) |
Get the sound buffer bound to a sound. | |
CSFML_API void | sfSound_SetLoop (sfSound *Sound, sfBool Loop) |
Set a sound loop state. | |
CSFML_API sfBool | sfSound_GetLoop (sfSound *Sound) |
Tell whether or not a sound is looping. | |
CSFML_API sfSoundStatus | sfSound_GetStatus (sfSound *Sound) |
Get the status of a sound (stopped, paused, playing). | |
CSFML_API void | sfSound_SetPitch (sfSound *Sound, float Pitch) |
Set the pitch of a sound. | |
CSFML_API void | sfSound_SetVolume (sfSound *Sound, float Volume) |
Set the volume of a sound. | |
CSFML_API void | sfSound_SetPosition (sfSound *Sound, float X, float Y, float Z) |
Set the position of a sound. | |
CSFML_API float | sfSound_GetPitch (sfSound *Sound) |
Get the pitch of a sound. | |
CSFML_API float | sfSound_GetVolume (sfSound *Sound) |
Get the volume of a sound. | |
CSFML_API void | sfSound_GetPosition (sfSound *Sound, float *X, float *Y, float *Z) |
Get the position of a sound. | |
CSFML_API float | sfSound_GetPlayingOffset (sfSound *Sound) |
Get the current playing position of a sound. |
CSFML_API sfSound* sfSound_Create | ( | ) |
Construct a new sound.
CSFML_API void sfSound_Destroy | ( | sfSound * | Sound | ) |
Destroy an existing sound.
Sound | : Sound to delete |
CSFML_API sfSoundBuffer* sfSound_GetBuffer | ( | sfSound * | Sound | ) |
Get the sound buffer bound to a sound.
Sound | : Sound to get the buffer from |
Tell whether or not a sound is looping.
Sound | : Sound to get the loop state from |
CSFML_API float sfSound_GetPitch | ( | sfSound * | Sound | ) |
Get the pitch of a sound.
Sound | : Sound to get the pitch from |
CSFML_API float sfSound_GetPlayingOffset | ( | sfSound * | Sound | ) |
Get the current playing position of a sound.
Sound | : Sound to get the position from |
CSFML_API void sfSound_GetPosition | ( | sfSound * | Sound, | |
float * | X, | |||
float * | Y, | |||
float * | Z | |||
) |
Get the position of a sound.
Sound | : Sound to get the position from | |
X | : X position of the sound in the world | |
Y | : Y position of the sound in the world | |
Z | : Z position of the sound in the world |
CSFML_API sfSoundStatus sfSound_GetStatus | ( | sfSound * | Sound | ) |
Get the status of a sound (stopped, paused, playing).
Sound | : Sound to get the status from |
CSFML_API float sfSound_GetVolume | ( | sfSound * | Sound | ) |
Get the volume of a sound.
Sound | : Sound to get the volume from |
CSFML_API void sfSound_Pause | ( | sfSound * | Sound | ) |
Pause a sound.
Sound | : Sound to pause |
CSFML_API void sfSound_Play | ( | sfSound * | Sound | ) |
Start playing a sound.
Sound | : Sound to play |
CSFML_API void sfSound_SetBuffer | ( | sfSound * | Sound, | |
sfSoundBuffer * | Buffer | |||
) |
Bind a sound buffer to a sound.
Sound | : Sound to set the loop state | |
Buffer | : Buffer to bind |
Set a sound loop state.
Sound | : Sound to set the loop state | |
Loop | : sfTrue to play in loop, sfFalse to play once |
CSFML_API void sfSound_SetPitch | ( | sfSound * | Sound, | |
float | Pitch | |||
) |
Set the pitch of a sound.
Sound | : Sound to modify | |
Pitch | : New pitch |
CSFML_API void sfSound_SetPosition | ( | sfSound * | Sound, | |
float | X, | |||
float | Y, | |||
float | Z | |||
) |
Set the position of a sound.
Sound | : Sound to modify | |
X | : X position of the sound in the world | |
Y | : Y position of the sound in the world | |
Z | : Z position of the sound in the world |
CSFML_API void sfSound_SetVolume | ( | sfSound * | Sound, | |
float | Volume | |||
) |
Set the volume of a sound.
Sound | : Sound to modify | |
Volume | : Volume (in range [0, 100]) |
CSFML_API void sfSound_Stop | ( | sfSound * | Sound | ) |
Stop playing a sound.
Sound | : Sound to stop |