(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

Draft

THIS PAGE IS A WORK IN PROGRESS ... Please make edits to this page to improve it!

SDL_GetDisplayUsableBounds

Get the usable desktop area represented by a display, in screen coordinates.

Header File

Defined in SDL_video.h, but apps should use #include <SDL3/SDL.h>

Syntax

int SDL_GetDisplayUsableBounds(SDL_DisplayID displayID, SDL_Rect *rect);

Function Parameters

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

Return Value

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

Remarks

This is the same area as SDL_GetDisplayBounds() reports, but with portions reserved by the system removed. For example, on Apple's macOS, this subtracts the area occupied by the menu bar and dock.

Setting a window to be fullscreen generally bypasses these unusable areas, so these are good guidelines for the maximum space available to a non-fullscreen window.

Version

This function is available since SDL 3.0.0.