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


Halt a channel after fading it out for a specified time.


int Mix_FadeOutChannel(int which, int ms);

Function Parameters


the channel to fade out.


number of milliseconds to fade before halting the channel.

Return Value

Returns the number of channels scheduled to fade.


This will begin a channel fading from its current volume to silence over ms milliseconds. After that time, the channel is halted.

Any halted channels will have any currently-registered effects deregistered, and will call any callback specified by Mix_ChannelFinished() once the halt occurs.

A fading channel will change it's volume progressively, as if Mix_Volume() was called on it (which is to say: you probably shouldn't call Mix_Volume() on a fading channel).

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


This function is available since SDL_mixer 2.0.0.


[ edit | delete | history | feedback | raw ]

[ 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.