目次 - SDL 3.0 API(機能別) - プロパティ - SDL_GetPointerProperty

SDL_GetPointerProperty

プロパティグループからポインタ型プロパティを得る

ヘッダ

SDL3/SDL_properties.h

構文

void * SDL_GetPointerProperty(SDL_PropertiesID props, const char *name, void *default_value);

引数

SDL_PropertiesIDprops問い合わせるプロパティグループ
const char *name問い合わせるプロパティの名前
void *default_valueプロパティのデフォルト値

戻り値

(void *) プロパティの値を戻す. 値が設定されていない, またはポインタ型プロパティでない場合はdefault_valueを戻す.

詳細

わかりやすいように, プロパティの名前は, SDLが外部に公開しているものは"SDL."で始まり, SDLが内部で使用しているものは"SDL.internal."で始まるようになっている. これらのプロパティは読み取り専用で, アプリケーションは更新してはならない.

スレッドセーフ

この関数はどのスレッドからも安全に呼べるが, 戻されたデータは保護されておらず, 別のスレッドから同じプロパティに対してSDL_SetPointerProperty()SDL_ClearProperty()が呼ばれて解放されてしまう可能性がある. これを防ぐためには, SDL_LockProperties()SDL_UnlockProperties()を使ってロックする必要がある.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_GetPointerProperty - SDL Wiki