目次 - SDL 3.0 API(機能別) - ディスプレイとウィンドウ - SDL_SetWindowIcon

SDL_SetWindowIcon

ウィンドウのアイコンを設定する

ヘッダ

SDL3/SDL_video.h

構文

bool SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon);

引数

SDL_Window *window設定するウィンドウ
SDL_Surface *iconウィンドウのアイコンのSDL_Surface

戻り値

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

詳細

この関数にSDL_AddSurfaceAlternateImage()で追加した別のバージョンの画像を持つサーフェイスを渡した場合, サーフェイスの画像は100%のディスプレイの表示と解釈され, 別のバージョンの画像は高DPIのとき使用される. 例えば, 元のサーフェイスが32×32で, macOSディスプレイで倍率2倍やWindowsの200%表示の場合, 可能ならば64×64のバージョンの画像が使用される. 一致するバージョンの画像が使えない場合は, 可能ならば代わりにサイズの大きな画像で最も近いものを縮小して使用する. 不可能ならば代わりにサイズの小さな画像で最も近いものを拡大して使用する.

スレッドセーフ

この関数を呼べるのはメインスレッドのみである.

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_SetWindowIcon - SDL Wiki