Function sdl2_sys::SDL_GetDisplayMode

source · 
pub unsafe extern "C" fn SDL_GetDisplayMode(
    displayIndex: c_int,
    modeIndex: c_int,
    mode: *mut SDL_DisplayMode
) -> c_int
Expand description

Get information about a specific display mode.

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

\param displayIndex the index of the display to query \param modeIndex the index of the display mode to query \param mode an SDL_DisplayMode structure filled in with the mode at modeIndex \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_GetNumDisplayModes