NAME¶

Mix_UnregisterEffect - Explicitly unregister a special effect function.

HEADER FILE¶

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

bool Mix_UnregisterEffect(int channel, Mix_EffectFunc_t f);

DESCRIPTION¶

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

Posteffects are never implicitly unregistered as they are for channels (as the output stream does not have an end), but they may be explicitly unregistered through this function by specifying

MIX_CHANNEL_POST
for a channel.

FUNCTION PARAMETERS¶

channel

the channel to unregister an effect on, or MIX_CHANNEL_POST .

f

effect the callback stop calling in future mixing iterations.

RETURN VALUE¶

Returns true on success or false on failure; call SDL_GetError() for more information.

AVAILABILITY¶

This function is available since SDL_mixer 3.0.0.