SDL_GetDisplayUsableBounds - Man Page

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

Header File

Defined in SDL3/SDL_video.h

Synopsis

#include "SDL3/SDL.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

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.

See Also

·(3), SDL_GetDisplayBounds(3), ·(3), SDL_GetDisplays(3)

Referenced By

SDL_GetDisplayBounds(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS