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

Mix_UnregisterAllEffects

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

構文

int Mix_UnregisterAllEffects(int channel)

引数

channel全てのエフェクトを解除するチャネル, またはMIX_CHANNEL_POST

戻り値

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

詳細

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

Mix_SetPanning()や内部でこのAPIを使用する他の組み込みエフェクトも無効にするので注意すること. この関数はチャネルの再生が完了したとき自動的に呼ばれる. これはチャネルを対象とするため, ポストエフェクトは解除されない. しかし, チャネルにMIX_CHANNEL_POSTを指定した場合は解除される.

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

バージョン

SDL_mixer 2.0.0以降

原文へのリンク

SDL_mixer/Mix_UnregisterAllEffects