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


Get information about the desktop's display mode.

Header File

Defined in SDL_video.h


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.


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.


This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryVideo

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.