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

SDL_GetWindowDisplayMode

Query the display mode to use when a window is visible at fullscreen.

Header File

Defined in SDL_video.h

Syntax

int SDL_GetWindowDisplayMode(SDL_Window * window,
                             SDL_DisplayMode * mode);

Function Parameters

window the window to query
mode an SDL_DisplayMode structure filled in with the fullscreen display mode

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryVideo