MIX_CreateMixer(3)

📦
version 3.2.4 · 2 versions
, in fedora 44

💖 MIX_CreateMixer(3) 💖

okay bestie, so this one lives in the SDL_mixer3 functions family, and it's literally the "make me a mixer that writes to memory" girlie. no speakers attached, no device, just vibes and a buffer ✨

🎀 NAME 🎀

MIX_CreateMixer — create a mixer that generates audio to a memory buffer.

🌸 SYNOPSIS 🌸

#include <SDL3_mixer/SDL_mixer.h>

MIX_Mixer * MIX_CreateMixer(const SDL_AudioSpec *spec);

🦋 DESCRIPTION 🦋

ngl, most of the time you do not want this function — you want MIX_CreateMixerDevice() instead. this one is the special-case cutie. the mixer you get here can be used with MIX_Generate() so you can produce more data on demand, and you can pull that data as fast as you want. periodt.

you gotta give it an audio format. like, it's not optional, bestie. that spec is the format the mixer will output in, and it cannot be NULL. like it literally cannot. don't try it. 🙈

once your mixer exists, the usual next steps are: load some audio (MIX_LoadAudio() and its little friend group), make a track (MIX_CreateTrack()), and then play that audio through that track. that's the whole pipeline, slay. 💅

and when you're done with your mixer, destroy it with MIX_DestroyMixer(). clean up after yourself, we love a responsible icon. 🫶

✨ FUNCTION PARAMETERS ✨

  • spec — the audio format that the mixer will generate. this is the main character of the argument list, no cap.

💫 RETURN VALUE 💫

returns a mixer you can use to generate audio, or NULL if it fails. if you get NULL, hit up SDL_GetError() for the tea on what went wrong, fr fr.

🧚 THREAD SAFETY 🧚

it is safe to call this function from any thread. go off, multithreaded queen. 👑

⭐ AVAILABILITY ⭐

this function has been available since SDL_mixer 3.0.0.

💜 SEE ALSO 💜

okay that's the whole page, bestie, you ate it up 🍓 and for the sign-off: this was brought to you by SDL_mixer, the SDL_mixer docs, version 3.2.4, and MIX_CreateMixer(3) herself — mwah, ily, go make some audio ✨💖🦋

📦 where this page comes from