SDL_GetCurrentDisplayMode(3)

SDL_GetCurrentDisplayMode3

Get information about the current display mode.

Usage

#include "SDL3/SDL.h"

const SDL_DisplayMode * SDL_GetCurrentDisplayMode(SDL_DisplayID displayID);

Header file

Defined in SDL3/SDL_video.h

Overview

There's a difference between this function and

SDL_GetDesktopDisplayMode () when SDL runs fullscreen and has changed the resolution. In that case this function will return the current display mode, and not the previous native 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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.