SDL_GetClosestFullscreenDisplayMode

Get the closest match to the requested display mode.

The available display modes are scanned and closest is filled in with the closest mode matching the requested mode and returned. The mode format and refresh rate default to the desktop mode if they are set to 0. The modes are scanned with size being first priority, format being second priority, and finally checking the refresh rate. If all the available modes are too small, then false is returned.

extern (C) nothrow @nogc extern
bool
SDL_GetClosestFullscreenDisplayMode

Parameters

displayID SDL_DisplayID

the instance ID of the display to query.

w int

the width in pixels of the desired display mode.

h int

the height in pixels of the desired display mode.

refresh_rate float

the refresh rate of the desired display mode, or 0.0f for the desktop refresh rate.

include_high_density_modes bool

boolean to include high density modes in the search.

closest SDL_DisplayMode*

a pointer filled in with the closest display mode equal to or larger than the desired mode.

Return Value

Type: bool

true on success or false on failure; call SDL_GetError() for more information.

Threadsafety: This function should only be called on the main thread.

See Also

Meta