[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.6.3 Mix_UnregisterAllEffects

int Mix_UnregisterAllEffects(int channel)

channel
Channel to remove all effects from.
Use MIX_CHANNEL_POST for the postmix stream.

This removes all effects registered to channel. If the channel is active all the registered effects will have their Mix_EffectDone_t functions called, if they were specified in Mix_RegisterEffect.

Returns: Zero on errors, such as channel not existing.

 
// remove all effects from channel 0
if(!Mix_UnregisterAllEffects(0)) {
    printf("Mix_UnregisterAllEffects: %s\n", Mix_GetError());
}

See Also:
4.6.2 Mix_UnregisterEffect, 4.6.1 Mix_RegisterEffect



This document was generated on November, 13 2009 using texi2html