目次 - SDL_mixer 3.0 - MIX_TagTrack

MIX_TagTrack

トラックに任意のタグを関連付ける

ヘッダ

SDL3_mixer/SDL_mixer.h

構文

bool MIX_TagTrack(MIX_Track *track, const char *tag);

引数

MIX_Track *trackタグを追加するトラック
const char *tag追加するタグ

戻り値

(bool) 成功のとき真, エラーのとき偽を戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

タグにはUTF-8でコード化したあらゆる有効なC文字列を設定できる. これは様々な目的でトラックをグループ化する場合に有用である. 例えばゲーム中で使用する全てのトラックに"game"をマークすると, ユーザが設定メニューを開いたとき, アプリケーションは即座にゲームプレーに関係する全てのトラックを一時停止させるがBGMと効果音は継続するようなことができる.

トラックにはマシンのメモリが許す限りいくつでもタグをつけることができる.

同じタグを1つのトラックに複数回追加しようとしても問題ない. 余分な追加は成功を戻すが何も変わらない.

タグは後でMIX_UntagTrack()で取り除くことができる.

スレッドセーフ

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

バージョン

SDL_image 3.0.0以降

関連項目

SDL Wikiへのリンク

SDL3_mixer/MIX_TagTrack