目次 - SDL_mixer 3.0 - MIX_GetTrackLoops

MIX_GetTrackLoops

トラックの残りループ回数を得る

ヘッダ

SDL3_mixer/SDL_mixer.h

構文

int MIX_GetTrackLoops(MIX_Track *track);

引数

MIX_Track *track問い合わせるトラック

戻り値

(int) 残りループ回数, ループがないとき0, ループが無限のとき-1を戻す.

詳細

この戻り値は残されたループの回数である. トラックの終了後にあと1回再生がある場合, この関数は1を戻す. ループするトラックだが, 最後のループの場合(これが完了したとき停止する), この関数は0を戻す.

トラックが無限にループする場合, -1を戻す. この値はエラーではない.

停止したトラック(再生中でなく, 一時停止中でない)は0回のループが残っているとみなされる.

様々な理由のエラー(MIX_Init()が呼ばれていない, トラックがNULLなど)の場合, この関数は0を戻すが, エラーとループのないトラックを判別する手段はない.

スレッドセーフ

この関数はどのスレッドからも安全に呼べる.

バージョン

SDL_image 3.0.0以降

SDL Wikiへのリンク

SDL3_mixer/MIX_GetTrackLoops