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

SDL_SetPointerPropertyWithCleanup

プロパティグループのポインタ型プロパティをプロパティが削除されたとき呼ばれる終了処理関数付きで設定する

ヘッダ

SDL3/SDL_properties.h

構文

bool SDL_SetPointerPropertyWithCleanup(SDL_PropertiesID props, const char *name, void *value, SDL_CleanupPropertyCallback cleanup, void *userdata);

引数

SDL_PropertiesIDprops設定するプロパティグループ
const char *name設定するプロパティの名前
void *valueプロパティの新しい値. NULLのときプロパティを削除する
SDL_CleanupPropertyCallbackcleanupプロパティが削除されたとき呼ばれる関数. 終了処理関数が不要のときNULL
void *userdata終了処理関数に渡すポインタ

戻り値

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

詳細

終了処理関数は, どのような理由でもプロパティの設定に失敗したときも呼ばれる.

整数型, ブール型, 文字列型などの基本的なデータ型を単に設定したい場合は, 代わりにSDL_SetNumberProperty, SDL_SetBooleanProperty, SDL_SetStringPropertyを使うこと. これらの関数はアプリケーションに代わって終了処理を行う. この関数は, より複雑なカスタムデータのためにのみ存在する.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_SetPointerPropertyWithCleanup - SDL Wiki