SDL_GetDisplayBounds

Get the desktop area represented by a display.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

bool SDL_GetDisplayBounds(SDL_DisplayID displayID, SDL_Rect *rect);

Function Parameters

SDL_DisplayID	displayID	the instance ID of the display to query.
SDL_Rect *	rect	the SDL_Rect structure filled in with the display bounds.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

The primary display is often located at (0,0), but may be placed at a different location depending on monitor layout.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.2.0.

See Also

• SDL_GetDisplayUsableBounds
• SDL_GetDisplays

---

CategoryAPI, CategoryAPIFunction, CategoryVideo

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.