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

SDL_CleanupPropertyCallback

汎用的なプロパティグループ名のマクロ

ヘッダ

SDL3/SDL_properties.h

構文

#define SDL_PROP_NAME_STRING "SDL.name"

詳細

このプロパティはプロパティグループの汎用的な名前が必要なSDL_PropertiesIDに追加することを意図している. 全てのプロパティグループにこのキーがある保証はないが, コードのどの箇所でも妥当に使用できる標準的なキーがあると便利である.

例えば, SDL_Textureに関連付けられたプロパティグループの名前の"player sprites"文字列や, SDL_AudioStreamの"background music"などである. これはSDL_IOStreamの資源のパス名の一覧の場合も有用かもしれない.

このキーの値に決められた形式はない. 人が読むことができる情報で, ログやデバッグで使用することを想定している.

SDLは現在は生成時にこのプロパティを設定しないが, 後のバージョンでは変更される可能性がある. 現在はアプリケーションと外部ライブラリが適切に利用することを想定している.

バージョン

SDL 3.4.0以降

SDL Wikiへのリンク

SDL_CleanupPropertyCallback - SDL Wiki