SDL_GetDisplayUsableBounds(3)

SDL_GetDisplayUsableBounds3

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

Usage

#include "SDL3/SDL.h"

bool SDL_GetDisplayUsableBounds(SDL_DisplayID displayID, SDL_Rect *rect);

Header file

Defined in SDL3/SDL_video.h

Overview

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

Returns true on success or false on failure; call

SDL_GetError () 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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.