目次 - SDL 3.0 API(機能別) - 初期化と終了 - SDL_SetAppMetadata

SDL_SetAppMetadata

アプリケーションの基本的なメタデータを指定する

ヘッダ

SDL3/SDL_init.h

構文

bool SDL_SetAppMetadata(const char *appname, const char *appversion, const char *appidentifier);

引数

const char *appnameアプリケーションの名前 ("My Game 2: Bad Guy's Revenge!")
const char *appversionアプリケーションのバージョン ("1.0.0beta5"やgitハッシュなど, 意味のあるものなら何でもよい)
const char *appidentifierアプリケーションのドメイン名を逆から呼んだ形式のユニークな文字列 ("com.example.mygame2")

戻り値

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

詳細

SDLにアプリケーションのメタデータを提供することができる(任意). これは必須ではないが, 強く推奨する.

SDLがメタデータを使用する箇所は複数ある(macOSの"About"ボックス, 一部のオーディオミキサーで表示されるアプリケーション名など). アプリケーションの詳細が意味をなさないと考えるならば, 各メタデータはNULLのままにすることができる.

この関数はなるべく早く, SDL_Initの前に呼ぶ必要がある. この関数を複数回呼ぶことはできる. しかし, 以前この関数で一度設定した値は変わらない.

各メタデータにNULLを渡すと以前の設定は消去される.

これは最も重要な情報のみの単純化されたインターフェースである. より詳細なメタデータはSDL_SetAppMetadataProperty()で設定できる.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_SetAppMetadata - SDL Wiki