plucky (3) SDL_GetDisplays.3.gz

Provided by: libsdl3-doc_3.2.4+ds-2_all bug

NAME
       SDL_GetDisplays - Get a list of currently connected displays.


HEADER FILE
       Defined in SDL3/SDL_video.h


SYNOPSIS
       #include "SDL3/SDL.h"

       SDL_DisplayID * SDL_GetDisplays(int *count);


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.