(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetDesktopDisplayMode

Get information about the desktop's display mode.

Header File

Syntax

const SDL_DisplayMode* SDL_GetDesktopDisplayMode(SDL_DisplayID displayID);

Function Parameters

displayID

the instance ID of the display to query

Return Value

Returns a pointer to the desktop display mode or NULL on error; 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 3.0.0.

Code Examples

SDL_DisplayID display_id = SDL_GetPrimaryDisplay();
const SDL_DisplayMode *display_mode = SDL_GetDesktopDisplayMode(display_id);
if (display_mode == NULL) {
    SDL_Log("SDL_GetDesktopDisplayMode failed: %s", SDL_GetError());
    return 1;
}