SDL_MixAudio(3)

💖 SDL_MixAudio 💖

okay bestie, so this one's from the SDL3 FUNCTIONS family, and it's literally the girl who mixes your audio for you ✨

---

🌸 NAME 🌸

SDL_MixAudio — mixes audio data in a specified format. that's it, that's the job, she does it flawlessly 💅

---

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_audio.h>

bool SDL_MixAudio(Uint8 *dst, const Uint8 *src, SDL_AudioFormat format, Uint32 len, float volume);

look at her, so clean, so iconic 👑

---

🦋 DESCRIPTION 🦋

so what she does is: she takes an audio buffer src — that's len bytes of format data — and mixes it into dst, and the way she does that is by performing addition, volume adjustment, and overflow clipping. no cap. and the buffer pointed to by dst has to also be len bytes of format data, so keep those two matching, bestie 🤝

she's provided for convenience — you can totally mix your own audio data if you want to be extra, that's your main character moment ✨

⚠️ do NOT use this function for mixing together more than two streams of sample data. like, seriously. the output from repeatedly applying this function may be distorted by clipping, because there's no accumulator with greater range than the input. (not to mention it's also just a straight up inefficient way of doing it 🙈). so, two streams max. periodt.

ok and here's a thing people get wrong all the time, it's a common misconception that this function is required to write audio data to an output stream in an audio callback. and like — sure, you can do that, but SDL_MixAudio() is really only needed when you're mixing a single audio stream with a volume adjustment. that's her whole thing 💜

---

🌈 FUNCTION PARAMETERS 🌈

• dst — the destination for the mixed audio 🫶
• src — the source audio buffer to be mixed ✨
• format — the SDL_AudioFormat structure representing the desired audio format 🎀
• len — the length of the audio buffer in bytes 📏
• volume — ranges from 0.0 - 1.0, and should be set to 1.0 for full audio volume 🔊 (so 1.0 = loud and proud, 0.0 = silence, you get it)

---

⭐ RETURN VALUE ⭐

returns true on success or false on failure 😭 and if she fails, call SDL_GetError() for more information — she'll tell you what went wrong, she's not mysterious like that.

---

💀 THREAD SAFETY 💀

it is safe to call this function from any thread. multitasking queen, we love to see it 👑

---

🍓 AVAILABILITY 🍓

this function has been available since SDL 3.2.0 🌱

---

🧚 SEE ALSO 🧚

hmm, the original didn't send us any SEE ALSO girlies, so that's a wrap on the cross-refs — but you already know SDL_GetError() from the return value section, iykyk 💖

---

and that's the whole page!! written by the fine folks over at Simple Directmedia Layer, from SDL 3.4.18, dated SDL_MixAudio(3) 🎀 stay mixed, stay clipped-free, mwah 💅💖✨