Man page - sdl_getdesktopdisplaymode(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_GetDesktopDisplayMode

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

SDL_GetDesktopDisplayMode - Get information about the desktop’s display mode.

HEADER FILE

Defined in SDL3/SDL_video.h

SYNOPSIS

#include "SDL3/SDL.h"

const SDL_DisplayMode * SDL_GetDesktopDisplayMode(SDL_DisplayID displayID);

DESCRIPTION

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.

FUNCTION PARAMETERS

displayID

the instance ID of the display to query.

RETURN VALUE

(const SDL_DisplayMode
*) Returns a pointer to the desktop display mode or NULL on failure; call

SDL_GetError () for more information.

THREAD SAFETY

This function should only be called on the main thread.

AVAILABILITY

This function is available since SDL 3.2.0.