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

SDL_GetDesktopDisplayMode

Get information about the desktop's display mode.

Header File

Syntax

const SDL_DisplayMode * SDL_GetDesktopDisplayMode(SDL_DisplayID displayID);

Function Parameters

SDL_DisplayID

displayID

the instance ID of the display to query.

Return Value

(const SDL_DisplayMode *) Returns a pointer to the desktop display mode or NULL 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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.