.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetClosestFullscreenDisplayMode:
.\"   https://wiki.libsdl.org/SDL_GetClosestFullscreenDisplayMode
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetClosestFullscreenDisplayMode
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetClosestFullscreenDisplayMode 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetClosestFullscreenDisplayMode \- Get the closest match to the requested display mode\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "const SDL_DisplayMode* SDL_GetClosestFullscreenDisplayMode(SDL_DisplayID displayID, int w, int h, float refresh_rate, SDL_bool include_high_density_modes);
.fi
.SH DESCRIPTION
The available display modes are scanned and
.BR closest
is filled in with the
closest mode matching the requested mode and returned\[char46] The mode format and
refresh rate default to the desktop mode if they are set to 0\[char46] The modes
are scanned with size being first priority, format being second priority,
and finally checking the refresh rate\[char46] If all the available modes are too
small, then NULL is returned\[char46]

.SH FUNCTION PARAMETERS
.TP
.I displayID
the instance ID of the display to query
.TP
.I w
the width in pixels of the desired display mode
.TP
.I h
the height in pixels of the desired display mode
.TP
.I refresh_rate
the refresh rate of the desired display mode, or 0\[char46]0f for the desktop refresh rate
.TP
.I include_high_density_modes
Boolean to include high density modes in the search
.SH RETURN VALUE
Returns a pointer to the closest display mode equal to or larger than the
desired mode, or NULL on error; call 
.BR SDL_GetError
() for
more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_GetDisplays (3),
.BR SDL_GetFullscreenDisplayModes (3)