NAME¶

Mix_UnregisterAllEffects - Explicitly unregister all special effect functions.

HEADER FILE¶

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

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

FUNCTION PARAMETERS¶

channel

the channel to unregister all effects on, or MIX_CHANNEL_POST .

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.