(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_GetClosestDisplayMode

Get the closest match to the requested display mode.

Header File

Syntax

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

Function Parameters

int	displayIndex	the index of the display to query.
const SDL_DisplayMode *	mode	an SDL_DisplayMode structure containing the desired display mode.
SDL_DisplayMode *	closest	an SDL_DisplayMode structure filled in with the closest match of the available display modes.

Return Value

(SDL_DisplayMode *) Returns the passed in value closest or NULL if no matching video mode was available; 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 NULL is returned.

Version

This function is available since SDL 2.0.0.