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

SDL_GetDisplayUsableBounds

ディスプレイに表示される利用可能なデスクトップの領域を得る

構文

int SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect* rect)

引数

displayIndex調査するディスプレイの番号
rectディスプレイの表示領域を代入するSDL_Rectポインタ

戻り値

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

詳細

主ディスプレイ(ディスプレイ番号0)の位置は常に(0,0)である.

これはSDL_GetDisplayBounds()と同じ表示領域を戻すが, システムが予約している部分が取り除かれている. 例えばApple Mac OS Xのならば, メニューバーとdockの占有する部分が引かれている.

ウィンドウをフルスクリーンにすると, 通常はこれらの領域は考慮されない. よって, この関数はフルスクリーンでないウィンドウで利用できる最大のサイズを得るよい指針となる.

引数rectがNULLの場合, 無視される.

引数displayIndexが範囲外の場合も, この関数は-1を戻す.

バージョン

SDL 2.0.5以降

関連項目(関数)

SDL_GetDisplayBounds
SDL_GetNumVideoDisplays

SDL Wikiへのリンク

SDL_GetDisplayUsableBounds - SDL Wiki