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

SDL_GetWindowBordersSize

ウィンドウのクライアント領域の周りにある枠(装飾)のサイズを得る

ヘッダ

SDL3/SDL_video.h

構文

bool SDL_GetWindowBordersSize(SDL_Window *window, int *top, int *left, int *bottom, int *right);

引数

SDL_Window *window枠(装飾)のサイズを問い合わせるウィンドウ
int *top上のサイズを代入する変数のポインタ. NULLも可
int *left左サイズを代入する変数のポインタ. NULLも可
int *bottom下のサイズを代入する変数のポインタ. NULLも可
int *right右のサイズを代入する変数のポインタ. NULLも可

戻り値

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

詳細

メモ: この関数が失敗した(偽を戻した)場合は, 枠がない場合と同じように, サイズは(引数がNULLでなければ)0, 0, 0, 0に初期化される.

メモ: この関数はディスプレイサーバがまだ装飾していない場合, 失敗する. (例えば, SDL_CreateWindow()を呼んだ直後) 少なくともウィンドウが表示・構成されるまで待ったほうがよい. そうすればウィンドウシステムがウィンドウを装飾することができ, 枠の寸法をSDLに提供できる.

この情報の獲得に対応していない場合も偽を戻す.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_GetWindowBordersSize - SDL Wiki