Wiki Page Content

SDL_GetDesktopDisplayMode

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

Syntax

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

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.


CategoryAPI, CategoryVideo

None: SDL_GetDesktopDisplayMode (last edited 2014-06-22 11:22:22 by PhilippWiesemann)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit