From af94d594a4a5601563f5fea9397b6a4aaf6bf8b0 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Thu, 9 May 2024 17:42:15 +0000
Subject: [PATCH] Sync SDL2_mixer wiki -> header
(cherry picked from commit 6e81ebbf07ac49f1770915a0be7d2afd59e6769f)
---
include/SDL_mixer.h | 45 +++++++++++++++++++++++----------------------
1 file changed, 23 insertions(+), 22 deletions(-)
diff --git a/include/SDL_mixer.h b/include/SDL_mixer.h
index 48190c475..f5448d4ab 100644
--- a/include/SDL_mixer.h
+++ b/include/SDL_mixer.h
@@ -66,21 +66,22 @@ extern "C" {
#define MIX_VERSION(X) SDL_MIXER_VERSION(X)
#if SDL_MIXER_MAJOR_VERSION < 3 && SDL_MAJOR_VERSION < 3
+
/**
- * This is the version number macro for the current SDL_mixer version.
+ * This is the version number macro for the current SDL_mixer version.
*
- * In versions higher than 2.9.0, the minor version overflows into
- * the thousands digit: for example, 2.23.0 is encoded as 4300.
- * This macro will not be available in SDL 3.x or SDL_mixer 3.x.
+ * In versions higher than 2.9.0, the minor version overflows into the
+ * thousands digit: for example, 2.23.0 is encoded as 4300. This macro will
+ * not be available in SDL 3.x or SDL_mixer 3.x.
*
- * Deprecated, use SDL_MIXER_VERSION_ATLEAST or SDL_MIXER_VERSION instead.
+ * Deprecated, use SDL_MIXER_VERSION_ATLEAST or SDL_MIXER_VERSION instead.
*/
#define SDL_MIXER_COMPILEDVERSION \
SDL_VERSIONNUM(SDL_MIXER_MAJOR_VERSION, SDL_MIXER_MINOR_VERSION, SDL_MIXER_PATCHLEVEL)
#endif /* SDL_MIXER_MAJOR_VERSION < 3 && SDL_MAJOR_VERSION < 3 */
/**
- * This macro will evaluate to true if compiled with SDL_mixer at least X.Y.Z.
+ * This macro will evaluate to true if compiled with SDL_mixer at least X.Y.Z.
*/
#define SDL_MIXER_VERSION_ATLEAST(X, Y, Z) \
((SDL_MIXER_MAJOR_VERSION >= X) && \
@@ -1264,29 +1265,29 @@ extern DECLSPEC void SDLCALL Mix_ChannelFinished(void (SDLCALL *channel_finished
/**
* This is the format of a special effect callback:
*
- * myeffect(int chan, void *stream, int len, void *udata);
+ * myeffect(int chan, void *stream, int len, void *udata);
*
- * (chan) is the channel number that your effect is affecting. (stream) is
- * the buffer of data to work upon. (len) is the size of (stream), and
- * (udata) is a user-defined bit of data, which you pass as the last arg of
- * Mix_RegisterEffect(), and is passed back unmolested to your callback.
- * Your effect changes the contents of (stream) based on whatever parameters
- * are significant, or just leaves it be, if you prefer. You can do whatever
- * you like to the buffer, though, and it will continue in its changed state
- * down the mixing pipeline, through any other effect functions, then finally
- * to be mixed with the rest of the channels and music for the final output
- * stream.
+ * (chan) is the channel number that your effect is affecting. (stream) is the
+ * buffer of data to work upon. (len) is the size of (stream), and (udata) is
+ * a user-defined bit of data, which you pass as the last arg of
+ * Mix_RegisterEffect(), and is passed back unmolested to your callback. Your
+ * effect changes the contents of (stream) based on whatever parameters are
+ * significant, or just leaves it be, if you prefer. You can do whatever you
+ * like to the buffer, though, and it will continue in its changed state down
+ * the mixing pipeline, through any other effect functions, then finally to be
+ * mixed with the rest of the channels and music for the final output stream.
*
* DO NOT EVER call SDL_LockAudio() from your callback function!
*/
typedef void (SDLCALL *Mix_EffectFunc_t)(int chan, void *stream, int len, void *udata);
/**
- * This is a callback that signifies that a channel has finished all its
- * loops and has completed playback. This gets called if the buffer
- * plays out normally, or if you call Mix_HaltChannel(), implicitly stop
- * a channel via Mix_AllocateChannels(), or unregister a callback while
- * it's still playing.
+ * This is a callback that signifies that a channel has finished all its loops
+ * and has completed playback.
+ *
+ * This gets called if the buffer plays out normally, or if you call
+ * Mix_HaltChannel(), implicitly stop a channel via Mix_AllocateChannels(), or
+ * unregister a callback while it's still playing.
*
* DO NOT EVER call SDL_LockAudio() from your callback function!
*/