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

Mix_GroupAvailable

Finds the first available channel in a group of channels.

Header File

Defined in <SDL3_mixer/SDL_mixer.h>

Syntax

int Mix_GroupAvailable(int tag);

Function Parameters

int

tag

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

Return Value

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

Remarks

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.

Version

This function is available since SDL_mixer 3.0.0.

---

CategoryAPI, CategoryAPIFunction

[ front page | index | search | recent changes | git repo | offline html ]

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