Scroll to navigation

Mix_GroupAvailable(3) SDL_mixer3 FUNCTIONS Mix_GroupAvailable(3)

NAME

Mix_GroupAvailable - Finds the first available channel in a group of channels.

SYNOPSIS

#include "SDL3_mixer/SDL_mixer.h"
int Mix_GroupAvailable(int tag);

DESCRIPTION

A tag is an arbitrary number that can be assigned to several mixer channels, to form groups of channels.

This function searches all channels with a specified tag, and returns the channel number of the first one it finds that is currently unused.

If no channels with the specified tag are unused, this function returns -1.

FUNCTION PARAMETERS

an arbitrary value, assigned to channels, to search for.

RETURN VALUE

Returns first available channel, or -1 if none are available.

AVAILABILITY

This function is available since SDL_mixer 3.0.0.

SDL_mixer 3.0.0 SDL_mixer