目次 - 4.関数 - 4.6エフェクト - Mix_UnregisterEffect

Mix_UnregisterEffect

エフェクト関数を解除する

構文

int Mix_UnregisterEffect(int channel, Mix_EffectFunc_t f)

引数

channelエフェクトを解除するチャネル, またはMIX_CHANNEL_POST
f effect the callback stop calling in future mixing iterations. 以降のミキシングから呼び出しを停止するエフェクトコールバック

戻り値

エラー(チャネルまたはエフェクトがない)のとき0, エフェクトが解除されたとき0以外を戻す. エラーメッセージはMix_GetError()で得られる.

詳細

チャンクの再生中にエフェクトを無効にしたい場合以外はこの関数を呼ぶ必要はない.

これはチャネルを対象とするため, ポストエフェクトは解除されない. しかし, チャネルにMIX_CHANNEL_POSTを指定した場合は解除される.

他のSDLやSDL_mixerの関数とは異なり, この関数は成功ではなくエラーのとき0を戻す.

バージョン

SDL_mixer 2.0.0以降

原文へのリンク

SDL_mixer/Mix_UnregisterEffect