(This function is part of SDL_mixer, a separate library from SDL.)

MIX_DestroyTrack

Destroy the specified track.

Header File

Defined in <SDL3_mixer/SDL_mixer.h>

Syntax

void MIX_DestroyTrack(MIX_Track *track);

Function Parameters

MIX_Track *

track

the track to destroy.

Remarks

If the track is currently playing, it will be stopped immediately, without any fadeout. If there is a callback set through MIX_SetTrackStoppedCallback(), it will not be called.

If the mixer is currently mixing in another thread, this will block until it finishes. 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; in this scenario, destroying a track and then making futher changes to it is considered undefined behavior.

Destroying a NULL MIX_Track is a legal no-op.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.

---

CategoryAPI, CategoryAPIFunction, CategorySDLMixer

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.