SDL_GetFullscreenDisplayModes(3)

SDL_GetFullscreenDisplayModes3

Get a list of fullscreen display modes available on a display.

Usage

#include "SDL3/SDL.h"

SDL_DisplayMode ** SDL_GetFullscreenDisplayModes(SDL_DisplayID displayID, int *count);

Header file

Defined in SDL3/SDL_video.h

Overview

The display modes are sorted in this priority:

• w -> largest to smallest

• h -> largest to smallest

• bits per pixel -> more colors to fewer colors

• packed pixel layout -> largest to smallest

• refresh rate -> highest to lowest

• pixel density -> lowest to highest

Function parameters

displayID

the instance ID of the display to query.

count

a pointer filled in with the number of display modes returned, may be NULL.

Return value

( SDL_DisplayMode ) Returns a NULL terminated array of display mode pointers or NULL on failure; call

SDL_GetError () for more information. This is a single allocation that should be freed with SDL_free () when it is no longer needed.

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.