SDL_GetDisplayBounds

Get the desktop area represented by a display.

Header File

Defined in SDL_video.h

Syntax

int SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);

Function Parameters

int displayIndex the index of the display to query.
SDL_Rect * rect the SDL_Rect structure filled in with the display bounds.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

The primary display (displayIndex zero) is always located at 0,0.

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryVideo