devela::_dep::sdl3::sys::video

Function SDL_GetDisplayUsableBounds

pub unsafe extern "C" fn SDL_GetDisplayUsableBounds(
    displayID: u32,
    rect: *mut SDL_Rect,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

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

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.

§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