MIX_SetTrackGain(3)

📦
version 3.2.4 · 2 versions
, in fedora 44

💖 MIX_SetTrackGain(3) 💖

okay bestie, welcome to the SDL_mixer3 FUNCTIONS corner of the manual, where we're talking about MIX_SetTrackGain — the little function that decides how loud one specific track is gonna be. yes, per-track. yes, it's iconic. let's get into it 🎀

✨ NAME ✨

MIX_SetTrackGain — set a track's gain control. that's it, that's the whole job 🫶

🌸 SYNOPSIS 🌸

#include <SDL3_mixer/SDL_mixer.h>

bool MIX_SetTrackGain(MIX_Track *track, float gain);

🦋 DESCRIPTION 🦋

so. every single track has its own gain, right? and that gain is literally just a lil knob for its overall volume. every sample coming out of that track gets modulated by this gain value. slay.

here's the vibe check on the numbers, no cap:

  • a gain of zero generates silence 🔇
  • 1.0f will not change the mixed volume
  • larger than 1.0f will increase the volume 🔥
  • negative values are illegal 💀 don't even try it
⚠️ there's no maximum gain specified, but this can quickly get extremely loud, so please be careful with this setting. fr fr. your ears are not the main character here, protect them 🙈

a track's gain defaults to 1.0f. cute, right? and you can change this value at any time to adjust the future mix. live adjustments, periodt 💅

👑 FUNCTION PARAMETERS 👑

  • track — the track to adjust. the one you're giving a glow-up to ✨
  • gain — the new gain value.

⭐ RETURN VALUE ⭐

returns true on success or false on failure 🥲 — and if it fails, call SDL_GetError() for more information. always check, bestie, it's giving responsible.

🌈 THREAD SAFETY 🌈

it is safe to call this function from any thread. yes queen, go wild, multitask, it's fine 🧚

🎀 AVAILABILITY 🎀

this function is available since SDL_mixer 3.0.0. so if you're on anything older, sorry babe, it's not there 😭

💜 SEE ALSO 💜

and that's the whole page, bestie! this was brought to you by SDL_mixer 3.2.4 (the version this page ships with), from the SDL_mixer era of the manual. go forth and gain responsibly 💖✨🎀

📦 where this page comes from