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

SDL_GetClosestDisplayMode

要求に最も近いディスプレイモードを検索する

構文

SDL_DisplayMode* SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode* mode, SDL_DisplayMode* closest)

引数

displayIndex調査するディスプレイの番号
mode要求するSDL_DisplayMode
closest要求に最も近い利用可能なモードを代入するSDL_DisplayModeのポインタ

戻り値

成功のときclosestへのポインタ, 利用可能なディスプレイモードがないときNULLを戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

利用可能なディスプレイモードが検索され, 要求と最も近いモードがclosestに代入される. modeのformatとrefresh_rateが0の場合, デスクトップのモードとなる. モードは, サイズを最優先で検索し, ピクセル形式は次の優先度となる. そして最後に更新周期をチェックする. 利用可能なモードが要求に対して小さすぎる場合, NULLを戻す.

関連項目(関数)

SDL_GetDisplayMode
SDL_GetNumDisplayModes

SDL Wikiへのリンク

SDL_GetClosestDisplayMode - SDL Wiki