NAME¶

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

SYNOPSIS¶

#include <SDL3/SDL_video.h>

bool SDL_GetDisplayUsableBounds(SDL_DisplayID displayID, SDL_Rect *rect);

DESCRIPTION¶

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.

FUNCTION PARAMETERS¶

displayID

the instance ID of the display to query.

rect

the SDL_Rect structure filled in with the display bounds.

RETURN VALUE¶

for more information.

THREAD SAFETY¶

This function should only be called on the main thread.

AVAILABILITY¶

This function is available since SDL 3.2.0.

SEE ALSO¶

SDL_GetDisplayBounds(3), SDL_GetDisplays(3)