Scroll to navigation

SDL_GetDisplayUsableBounds(3) SDL3 FUNCTIONS SDL_GetDisplayUsableBounds(3)

NAME

SDL_GetDisplayUsableBounds - 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

the instance ID of the display to query.
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.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

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

SDL 3.1.6 Simple Directmedia Layer