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

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

Return Value

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:

• width -> largest to smallest
• height -> largest to smallest
• bits per pixel -> more colors to fewer colors
• packed pixel layout -> largest to smallest
• refresh rate -> highest to lowest

Version

This function is available since SDL 2.0.0.

See Also

• SDL_GetNumDisplayModes

CategoryAPI, CategoryAPIFunction, CategoryVideo