SDL_GetDisplayMode

Get information about a specific display mode.

Header File

Defined in SDL_video.h

Syntax

int SDL_GetDisplayMode(int displayIndex, int modeIndex,
                       SDL_DisplayMode * mode);

Function Parameters

int displayIndex the index of the display to query.
int modeIndex the index of the display mode to query.
SDL_DisplayMode * mode an SDL_DisplayMode structure filled in with the mode at modeIndex.

Return Value

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

Remarks

The display modes are sorted in this priority:

Version

This function is available since SDL 2.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryVideo