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

SDL_GetWindowBordersSize

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

構文

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

引数

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

戻り値

成功のとき0, 失敗のとき負の数のエラーコードを戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

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

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

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

バージョン

SDL 2.0.5以降

関連項目(関数)

SDL_GetWindowSize

SDL Wikiへのリンク

SDL_GetWindowBordersSize - SDL Wiki