SDL_GetDisplays(3)

SDL_GetDisplays3

Get a list of currently connected displays.

Usage

#include "SDL3/SDL.h"

SDL_DisplayID * SDL_GetDisplays(int *count);

Header file

Defined in SDL3/SDL_video.h

Function parameters

count

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

Return value

( SDL_DisplayID
*) Returns a 0 terminated array of display instance IDs or NULL on failure; call SDL_GetError () for more information. This 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.