SDL_GetClosestFullscreenDisplayMode - Get the closest match to the requested display mode.
Contents
Availability
This function is available since SDL 3.2.0.
Description
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.
Function Parameters
displayID
the instance ID of the display to query.
w the width in pixels of the desired display mode.
h the height in pixels of the desired display mode.
refresh_rate
the refresh rate of the desired display mode, or 0.0f for the desktop refresh rate.
include_high_density_modes
boolean to include high density modes in the search.
closest
a pointer filled in with the closest display mode equal to or larger than the desired mode.
Header File
Defined in SDL3/SDL_video.h
Name
SDL_GetClosestFullscreenDisplayMode - Get the closest match to the requested display mode.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
See Also
•(3), SDL_GetDisplays(3), •(3), SDL_GetFullscreenDisplayModes(3) Simple Directmedia Layer SDL 3.2.10 SDL_GetClosestFullscreenDisplayMode(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_GetClosestFullscreenDisplayMode(SDL_DisplayIDdisplayID,intw,inth,floatrefresh_rate,boolinclude_high_density_modes,SDL_DisplayMode*closest);
Thread Safety
This function should only be called on the main thread.
