(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetClosestFullscreenDisplayMode

Get the closest match to the requested display mode.

Header File

Syntax

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

Function Parameters

SDL_DisplayID	displayID	the instance ID of the display to query.
int	w	the width in pixels of the desired display mode.
int	h	the height in pixels of the desired display mode.
float	refresh_rate	the refresh rate of the desired display mode, or 0.0f for the desktop refresh rate.
bool	include_high_density_modes	boolean to include high density modes in the search.
SDL_DisplayMode *	closest	a pointer filled in with the closest display mode equal to or larger than the desired mode.

Return Value

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

Remarks

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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.