MIX_DestroyTrack(3)

📦
version 3.2.4 · 2 versions
, in fedora 44

✨ MIX_DestroyTrack ✨

okay bestie, welcome to MIX_DestroyTrack(3) — it's a page from the SDL_mixer3 girlies (that's the manual section, keep up 💅) and it's all about yeeting a track into the void. bye boo 👋

🌸 NAME 🌸

MIX_DestroyTrack — destroy the specified track. that's it. that's the whole vibe. 💀

🎀 SYNOPSIS 🎀

#include <SDL3_mixer/SDL_mixer.h>

void MIX_DestroyTrack(MIX_Track *track);

like, one include, one function call. so simple. so iconic. ✨

💖 DESCRIPTION 💖

okay so here's the tea, and you need to hear it ☕

If the track is currently playing, it gets stopped immediately — no fadeout, no gentle exit, no little goodbye wave 😭 it's just gone. Instant. Like your ex's attention span.

And if there's a callback set through MIX_SetTrackStoppedCallback(), it will _not_ be called. Not even a little bit. Not once. Don't @ me. 🙈 that's just how it is.

If the mixer is currently mixing in another thread, this will block until it finishes. like it will literally sit there and wait its turn, very demure, very mindful 🧚

Now this next part is the important one, so listen up 👑

Destroying a track from the mixer thread itself (during a callback) will cause it to be destroyed as soon as this iteration of the mixer thread is not using it. slay, scheduling! 🦋

BUT — in this scenario, destroying a track and then making futher changes to it is considered undefined behavior. 🚨 that means all bets are off, the universe stops making sense, no cap. do not touch it after you destroy it. periodt. 💀

Last thing, and it's a cute one: destroying a NULL MIX_Track is a legal no-op. so if you pass in nothing, it's fine, it just vibes. no crash, no drama, no main character meltdown. 💅

🌈 FUNCTION PARAMETERS 🌈

  • track — the track to destroy. yeah. the one you're destroying. the one and only. give it here 🫶

⭐ THREAD SAFETY ⭐

It is safe to call this function from any thread. any of them. all of them. go feral, bestie, the thread police are not coming 🔥

👑 AVAILABILITY 👑

This function is available since SDL_mixer 3.0.0. so she's been here a minute, she's not new money 💜

okay that's the whole page!! go forth and destroy tracks responsibly 🌸

shoutout to the SDL_mixer girlies for this one, straight from the manual, version SDL_mixer 3.2.4 — mwah, love you, bye 🎀✨💖

📦 where this page comes from