Scroll to navigation

MIX_TrackLooping(3) SDL_mixer3 FUNCTIONS MIX_TrackLooping(3)

NAME

MIX_TrackLooping - Query whether a given track is looping.

HEADER FILE

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS

#include "SDL3_mixer/SDL_mixer.h"
bool MIX_TrackLooping(MIX_Track *track);

DESCRIPTION

This specifically checks if the track is _not stopped_ (paused or playing), and there is at least one loop remaining. If a track _was_ looping but is on its final iteration of the loop, this will return false.

On various errors ( MIX_Init () was not called, the track is NULL), this returns false, but there is no mechanism to distinguish errors from non-looping tracks.

FUNCTION PARAMETERS

the track to query.

RETURN VALUE

Returns true if looping, false otherwise.

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL_mixer 3.0.0.

SDL_mixer 3.1.0 SDL_mixer