Function sdl2_sys::SDL_GetDesktopDisplayMode

source ·

pub unsafe extern "C" fn SDL_GetDesktopDisplayMode(
    displayIndex: c_int,
    mode: *mut SDL_DisplayMode
) -> c_int

Expand description

Get information about the desktop’s display mode.

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.

\param displayIndex the index of the display to query \param mode an SDL_DisplayMode structure filled in with the current display mode \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_GetCurrentDisplayMode \sa SDL_GetDisplayMode \sa SDL_SetWindowDisplayMode