mirror of
https://github.com/SFML/CSFML.git
synced 2026-10-27 21:36:13 +01:00
Updated to the new naming convention
This commit is contained in:
Laurent Gomila committed
1 parent
9d0d0588b2
commit
36904a45d9
99 files changed
+2409
-2369
No files matched your search
+31
-31
@@ -41,7 +41,7 @@
|
||||
/// \brief Create a new music and load it from a file
|
||||
///
|
||||
/// This function doesn't start playing the music (call
|
||||
/// sfMusic_Play to do so).
|
||||
/// sfMusic_play to do so).
|
||||
/// Here is a complete list of all the supported audio formats:
|
||||
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam,
|
||||
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
|
||||
@@ -51,13 +51,13 @@
|
||||
/// \return A new sfMusic object (NULL if failed)
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfMusic* sfMusic_CreateFromFile(const char* filename);
|
||||
CSFML_AUDIO_API sfMusic* sfMusic_createFromFile(const char* filename);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Create a new music and load it from a file in memory
|
||||
///
|
||||
/// This function doesn't start playing the music (call
|
||||
/// sfMusic_Play to do so).
|
||||
/// sfMusic_play to do so).
|
||||
/// Here is a complete list of all the supported audio formats:
|
||||
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam,
|
||||
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
|
||||
@@ -68,13 +68,13 @@ CSFML_AUDIO_API sfMusic* sfMusic_CreateFromFile(const char* filename);
|
||||
/// \return A new sfMusic object (NULL if failed)
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfMusic* sfMusic_CreateFromMemory(const void* data, size_t sizeInBytes);
|
||||
CSFML_AUDIO_API sfMusic* sfMusic_createFromMemory(const void* data, size_t sizeInBytes);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Create a new music and load it from a custom stream
|
||||
///
|
||||
/// This function doesn't start playing the music (call
|
||||
/// sfMusic_Play to do so).
|
||||
/// sfMusic_play to do so).
|
||||
/// Here is a complete list of all the supported audio formats:
|
||||
/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam,
|
||||
/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
|
||||
@@ -84,7 +84,7 @@ CSFML_AUDIO_API sfMusic* sfMusic_CreateFromMemory(const void* data, size_t sizeI
|
||||
/// \return A new sfMusic object (NULL if failed)
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfMusic* sfMusic_CreateFromStream(sfInputStream* stream);
|
||||
CSFML_AUDIO_API sfMusic* sfMusic_createFromStream(sfInputStream* stream);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Destroy a music
|
||||
@@ -92,21 +92,21 @@ CSFML_AUDIO_API sfMusic* sfMusic_CreateFromStream(sfInputStream* stream);
|
||||
/// \param music Music to destroy
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_Destroy(sfMusic* music);
|
||||
CSFML_AUDIO_API void sfMusic_destroy(sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Set whether or not a music should loop after reaching the end
|
||||
///
|
||||
/// If set, the music will restart from beginning after
|
||||
/// reaching the end and so on, until it is stopped or
|
||||
/// sfMusic_SetLoop(music, sfFalse) is called.
|
||||
/// sfMusic_setLoop(music, sfFalse) is called.
|
||||
/// The default looping state for musics is false.
|
||||
///
|
||||
/// \param music Music object
|
||||
/// \param loop sfTrue to play in loop, sfFalse to play once
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_SetLoop(sfMusic* music, sfBool loop);
|
||||
CSFML_AUDIO_API void sfMusic_setLoop(sfMusic* music, sfBool loop);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Tell whether or not a music is in loop mode
|
||||
@@ -116,7 +116,7 @@ CSFML_AUDIO_API void sfMusic_SetLoop(sfMusic* music, sfBool loop);
|
||||
/// \return sfTrue if the music is looping, sfFalse otherwise
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfBool sfMusic_GetLoop(const sfMusic* music);
|
||||
CSFML_AUDIO_API sfBool sfMusic_getLoop(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the total duration of a music
|
||||
@@ -126,7 +126,7 @@ CSFML_AUDIO_API sfBool sfMusic_GetLoop(const sfMusic* music);
|
||||
/// \return Music duration
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfTime sfMusic_GetDuration(const sfMusic* music);
|
||||
CSFML_AUDIO_API sfTime sfMusic_getDuration(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Start or resume playing a music
|
||||
@@ -140,7 +140,7 @@ CSFML_AUDIO_API sfTime sfMusic_GetDuration(const sfMusic* music);
|
||||
/// \param music Music object
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_Play(sfMusic* music);
|
||||
CSFML_AUDIO_API void sfMusic_play(sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Pause a music
|
||||
@@ -151,7 +151,7 @@ CSFML_AUDIO_API void sfMusic_Play(sfMusic* music);
|
||||
/// \param music Music object
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_Pause(sfMusic* music);
|
||||
CSFML_AUDIO_API void sfMusic_pause(sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Stop playing a music
|
||||
@@ -163,7 +163,7 @@ CSFML_AUDIO_API void sfMusic_Pause(sfMusic* music);
|
||||
/// \param music Music object
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_Stop(sfMusic* music);
|
||||
CSFML_AUDIO_API void sfMusic_stop(sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Return the number of channels of a music
|
||||
@@ -175,7 +175,7 @@ CSFML_AUDIO_API void sfMusic_Stop(sfMusic* music);
|
||||
/// \return Number of channels
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API unsigned int sfMusic_GetChannelCount(const sfMusic* music);
|
||||
CSFML_AUDIO_API unsigned int sfMusic_getChannelCount(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the sample rate of a music
|
||||
@@ -188,7 +188,7 @@ CSFML_AUDIO_API unsigned int sfMusic_GetChannelCount(const sfMusic* music);
|
||||
/// \return Sample rate, in number of samples per second
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API unsigned int sfMusic_GetSampleRate(const sfMusic* music);
|
||||
CSFML_AUDIO_API unsigned int sfMusic_getSampleRate(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the current status of a music (stopped, paused, playing)
|
||||
@@ -198,7 +198,7 @@ CSFML_AUDIO_API unsigned int sfMusic_GetSampleRate(const sfMusic* music);
|
||||
/// \return Current status
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfSoundStatus sfMusic_GetStatus(const sfMusic* music);
|
||||
CSFML_AUDIO_API sfSoundStatus sfMusic_getStatus(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the current playing position of a music
|
||||
@@ -208,7 +208,7 @@ CSFML_AUDIO_API sfSoundStatus sfMusic_GetStatus(const sfMusic* music);
|
||||
/// \return Current playing position
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfTime sfMusic_GetPlayingOffset(const sfMusic* music);
|
||||
CSFML_AUDIO_API sfTime sfMusic_getPlayingOffset(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Set the pitch of a music
|
||||
@@ -223,7 +223,7 @@ CSFML_AUDIO_API sfTime sfMusic_GetPlayingOffset(const sfMusic* music);
|
||||
/// \param pitch New pitch to apply to the music
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_SetPitch(sfMusic* music, float pitch);
|
||||
CSFML_AUDIO_API void sfMusic_setPitch(sfMusic* music, float pitch);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Set the volume of a music
|
||||
@@ -235,7 +235,7 @@ CSFML_AUDIO_API void sfMusic_SetPitch(sfMusic* music, float pitch);
|
||||
/// \param volume Volume of the music
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_SetVolume(sfMusic* music, float volume);
|
||||
CSFML_AUDIO_API void sfMusic_setVolume(sfMusic* music, float volume);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Set the 3D position of a music in the audio scene
|
||||
@@ -248,7 +248,7 @@ CSFML_AUDIO_API void sfMusic_SetVolume(sfMusic* music, float volume);
|
||||
/// \param position Position of the music in the scene
|
||||
//
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_SetPosition(sfMusic* music, sfVector3f position);
|
||||
CSFML_AUDIO_API void sfMusic_setPosition(sfMusic* music, sfVector3f position);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Make a musics's position relative to the listener or absolute
|
||||
@@ -263,7 +263,7 @@ CSFML_AUDIO_API void sfMusic_SetPosition(sfMusic* music, sfVector3f position);
|
||||
/// \param relative sfTrue to set the position relative, sfFalse to set it absolute
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_SetRelativeToListener(sfMusic* music, sfBool relative);
|
||||
CSFML_AUDIO_API void sfMusic_setRelativeToListener(sfMusic* music, sfBool relative);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Set the minimum distance of a music
|
||||
@@ -279,7 +279,7 @@ CSFML_AUDIO_API void sfMusic_SetRelativeToListener(sfMusic* music, sfBool relati
|
||||
/// \param distance New minimum distance of the music
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_SetMinDistance(sfMusic* music, float distance);
|
||||
CSFML_AUDIO_API void sfMusic_setMinDistance(sfMusic* music, float distance);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Set the attenuation factor of a music
|
||||
@@ -297,7 +297,7 @@ CSFML_AUDIO_API void sfMusic_SetMinDistance(sfMusic* music, float distance);
|
||||
/// \param attenuation New attenuation factor of the music
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_SetAttenuation(sfMusic* music, float attenuation);
|
||||
CSFML_AUDIO_API void sfMusic_setAttenuation(sfMusic* music, float attenuation);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Change the current playing position of a music
|
||||
@@ -309,7 +309,7 @@ CSFML_AUDIO_API void sfMusic_SetAttenuation(sfMusic* music, float attenuation);
|
||||
/// \param timeOffset New playing position, in milliseconds
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API void sfMusic_SetPlayingOffset(sfMusic* music, sfUint32 timeOffset);
|
||||
CSFML_AUDIO_API void sfMusic_setPlayingOffset(sfMusic* music, sfUint32 timeOffset);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the pitch of a music
|
||||
@@ -319,7 +319,7 @@ CSFML_AUDIO_API void sfMusic_SetPlayingOffset(sfMusic* music, sfUint32 timeOffse
|
||||
/// \return Pitch of the music
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API float sfMusic_GetPitch(const sfMusic* music);
|
||||
CSFML_AUDIO_API float sfMusic_getPitch(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the volume of a music
|
||||
@@ -329,7 +329,7 @@ CSFML_AUDIO_API float sfMusic_GetPitch(const sfMusic* music);
|
||||
/// \return Volume of the music, in the range [0, 100]
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API float sfMusic_GetVolume(const sfMusic* music);
|
||||
CSFML_AUDIO_API float sfMusic_getVolume(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the 3D position of a music in the audio scene
|
||||
@@ -339,7 +339,7 @@ CSFML_AUDIO_API float sfMusic_GetVolume(const sfMusic* music);
|
||||
/// \return Position of the music in the world
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfVector3f sfMusic_GetPosition(const sfMusic* music);
|
||||
CSFML_AUDIO_API sfVector3f sfMusic_getPosition(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Tell whether a music's position is relative to the
|
||||
@@ -350,7 +350,7 @@ CSFML_AUDIO_API sfVector3f sfMusic_GetPosition(const sfMusic* music);
|
||||
/// \return sfTrue if the position is relative, sfFalse if it's absolute
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API sfBool sfMusic_IsRelativeToListener(const sfMusic* music);
|
||||
CSFML_AUDIO_API sfBool sfMusic_isRelativeToListener(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the minimum distance of a music
|
||||
@@ -360,7 +360,7 @@ CSFML_AUDIO_API sfBool sfMusic_IsRelativeToListener(const sfMusic* music);
|
||||
/// \return Minimum distance of the music
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API float sfMusic_GetMinDistance(const sfMusic* music);
|
||||
CSFML_AUDIO_API float sfMusic_getMinDistance(const sfMusic* music);
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// \brief Get the attenuation factor of a music
|
||||
@@ -370,7 +370,7 @@ CSFML_AUDIO_API float sfMusic_GetMinDistance(const sfMusic* music);
|
||||
/// \return Attenuation factor of the music
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
CSFML_AUDIO_API float sfMusic_GetAttenuation(const sfMusic* music);
|
||||
CSFML_AUDIO_API float sfMusic_getAttenuation(const sfMusic* music);
|
||||
|
||||
|
||||
#endif // SFML_MUSIC_H
|
||||
Reference in new issue
Block a user