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

SDL_GetDesktopDisplayMode

Get information about the desktop's display mode.

Header File

Syntax

int SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);

Function Parameters

int	displayIndex	the index of the display to query.
SDL_DisplayMode *	mode	an SDL_DisplayMode structure filled in with the current display mode.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

There's a difference between this function and SDL_GetCurrentDisplayMode() when SDL runs fullscreen and has changed the resolution. In that case this function will return the previous native display mode, and not the current display mode.

Version

This function is available since SDL 2.0.0.