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

SDL_GetClosestFullscreenDisplayMode

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

ヘッダ

SDL3/SDL_video.h

構文

bool SDL_GetClosestFullscreenDisplayMode(SDL_DisplayID displayID, int w, int h, float refresh_rate, bool include_high_density_modes, SDL_DisplayMode *closest);

引数

SDL_DisplayIDdisplayID問い合わせるディスプレイのインスタンスID
intw要求するディスプレイモードの横ピクセル数
inth要求するディスプレイモードの縦ピクセル数
floatrefresh_rate要求するディスプレイモードの更新周期. 0.0fのときデスクトップの更新周期
boolinclude_high_density_modes検索に高密度モードを含めるか
SDL_DisplayMode *closest要求と一致する, または要求よりも大きなモードの代入先へのポインタ

戻り値

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

詳細

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

スレッドセーフ

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

バージョン

SDL 3.2.0以降

SDL Wikiへのリンク

SDL_GetClosestFullscreenDisplayMode - SDL Wiki