NAME¶

Mix_UnregisterAllEffects - Explicitly unregister all special effect functions.

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

int Mix_UnregisterAllEffects(int channel);

DESCRIPTION¶

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

Note that this will also shut off some internal effect processing, since

Mix_SetPanning () and others may use this API under the hood. This is called internally when a channel completes playback. 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.

Note that unlike most SDL and SDL_mixer functions, this function returns zero if there's an error, not on success. We apologize for the API design inconsistency here.

FUNCTION PARAMETERS¶

channel

the channel to unregister all effects on, or MIX_CHANNEL_POST .

RETURN VALUE¶

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

AVAILABILITY¶

This function is available since SDL_mixer 3.0.0.