目次 - SDL 3.0 API(機能別) - メイン - SDL_RegisterApp

SDL_RegisterApp

SDLが使用するためにwin32ウィンドウクラスを登録する

ヘッダ

SDL3/SDL_main.h

構文

bool SDL_RegisterApp(const char *name, Uint32 style, void *hInst);

引数

const char *titleUTF-8文字列のウィンドウクラス名. NULLの場合は現在は"SDL_app"だが, その保証はない
Uint32styleWNDCLASSEX::styleで使うための値
void *hInstWNDCLASSEX::hInstanceで使うためのHINSTANCE. 0の場合は, SDLは代わりにGetModuleHandle(NULL)を使用する

戻り値

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

詳細

この関数は, スタートアップ時にアプリケーションのウィンドウクラスを設定するために使用する. 複数回呼んでもSDL_UnregisterAppの呼び出しと対になっている限り安全だが, 前回の登録がまだ有効な状態で2度目の設定をしようとしても, カウンタが増すだけで無視される.

ほとんどのアプリケーションは, この関数を直接呼ぶ必要はなく, また呼ばない方がよい. SDLはビデオサブシステムの初期化でこの関数を呼んでいる.

nameがNULLの場合, SDLは現在はstyleの値として設定に関わらず(CS_BYTEALIGNCLIENT | CS_OWNDC)を使用する.

バージョン

SDL 3.2.0以降

SDL Wikiへのリンク

SDL_RegisterApp - SDL Wiki