====== (This is the documentation for SDL3, which is under heavy development and the API is changing! [https://wiki.libsdl.org/SDL2/ 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. == Syntax == int SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect *rect); == Function Parameters == {| |'''displayIndex''' |the index of the display to query the usable bounds from |- |'''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 == The primary display (displayIndex zero) is always located at 0,0. 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. The parameter rect is ignored if it is NULL. This function also returns -1 if the parameter displayIndex is out of range. == Version == This function is available since SDL 3.0.0. == Related Functions == :[[SDL_GetDisplayBounds]] :[[SDL_GetNumVideoDisplays]] ---- [[CategoryAPI]], [[CategoryVideo]], [[CategoryDraft]]