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

Mix_UnregisterEffect

You may not need to call this explicitly, unless you need to stop an effect from processing in the middle of a chunk's playback.

Syntax

int Mix_UnregisterEffect(int channel, Mix_EffectFunc_t f);

Function Parameters

channel

channel

f

effect callback

Return Value

Returns zero if error (no such channel or effect), nonzero if removed. Error messages can be retrieved from Mix_GetError().

Remarks

Posteffects are never implicitly unregistered as they are for channels, but they may be explicitly unregistered through this function by specifying MIX_CHANNEL_POST for a channel.

Version

This function is available since SDL_mixer 2.0.0.


CategoryAPI


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