sdlGetDisplayUsableBounds function
Get the usable desktop area represented by a display.
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.
\param displayIndex the index of the display to query the usable bounds from \param rect the SDL_Rect structure filled in with the display bounds \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
\since This function is available since SDL 2.0.5.
\sa SDL_GetDisplayBounds \sa SDL_GetNumVideoDisplays
extern DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(int displayIndex, SDL_Rect * rect)
Implementation
int sdlGetDisplayUsableBounds(int displayIndex, Pointer<SdlRect> rect) {
final sdlGetDisplayUsableBoundsLookupFunction = libSdl2.lookupFunction<
Int32 Function(Int32 displayIndex, Pointer<SdlRect> rect),
int Function(int displayIndex,
Pointer<SdlRect> rect)>('SDL_GetDisplayUsableBounds');
return sdlGetDisplayUsableBoundsLookupFunction(displayIndex, rect);
}