.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL_mixer's wiki page for Mix_FadeOutGroup:
.\"   https://wiki.libsdl.org/SDL_mixer/Mix_FadeOutGroup
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision 3~git20240319~12fb85e+ds-1
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20Mix_FadeOutGroup
.\" SDL_mixer can be found at https://libsdl.org/projects/SDL_mixer
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH Mix_FadeOutGroup 3 "SDL_mixer 3.0.0" "SDL_mixer" "SDL_mixer3 FUNCTIONS"
.SH NAME
Mix_FadeOutGroup \- Halt a playing group of channels by arbitrary tag, after fading them out for a specified time\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3_mixer/SDL_mixer.h\(dq
.PP
.BI "int Mix_FadeOutGroup(int tag, int ms);
.fi
.SH DESCRIPTION
This will begin fading a group of channels with a specific tag from their
current volumes to silence over
.BR ms
milliseconds\[char46] After that time, those
channels are halted\[char46]

A tag is an arbitrary number that can be assigned to several mixer
channels, to form groups of channels\[char46]

The default tag for a channel is -1\[char46]

Any halted channels will have any currently-registered effects
deregistered, and will call any callback specified by

.BR Mix_ChannelFinished
() once the halt occurs\[char46]

A fading channel will change it's volume progressively, as if

.BR Mix_Volume
() was called on it (which is to say: you probably
shouldn't call 
.BR Mix_Volume
() on a fading channel)\[char46]

Note that this function does not block for the number of milliseconds
requested; it just schedules the group to fade and notes the time for the
mixer to manage later, and returns immediately\[char46]

.SH FUNCTION PARAMETERS
.TP
.I tag
an arbitrary value, assigned to channels, to search for\[char46]
.TP
.I ms
number of milliseconds to fade before halting the group\[char46]
.SH RETURN VALUE
Returns the number of channels that were scheduled for fading\[char46]

.SH AVAILABILITY
This function is available since SDL_mixer 3\[char46]0\[char46]0\[char46]