This is new wiki software and old wiki content. It's a work in progress!
Here's the explanation.
Be gentle, report bugs, leave feedback on pages, or just edit them yourself! Thanks!

SDL Wiki

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.

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 2.0.5.

SDL_GetDisplayBounds
SDL_GetNumVideoDisplays

CategoryAPI, CategoryVideo, CategoryDraft


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.