#pragma section-numbers off
#pragma disable-camelcase

= SDL_GetDesktopDisplayMode =
Use this function to get information about the desktop display mode.

<<TableOfContents()>>

== Syntax ==
{{{#!highlight cpp
int SDL_GetDesktopDisplayMode(int              displayIndex,
                              SDL_DisplayMode* mode)
}}}

== Function Parameters ==
||'''displayIndex'''||the index of the display to query||
||'''mode'''||an [[SDL_DisplayMode]] structure filled in with the current display mode||

== Return Value ==
Returns 0 on success or a negative error code on failure; call [[SDL_GetError]]() for more information.

== Code Examples ==
{{{#!highlight cpp
SDL_DisplayMode dm;
if (SDL_GetDesktopDisplayMode(0, &dm) != 0) {
    SDL_Log("SDL_GetDesktopDisplayMode failed: %s", SDL_GetError());
    return 1;
}
}}}

== 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.

== Related Functions ==
 .[[SDL_GetCurrentDisplayMode]]
 .[[SDL_GetDisplayMode]]
 .[[SDL_SetWindowDisplayMode]]

----
[[CategoryAPI]], [[CategoryVideo]]