sdlGetWindowSafeArea function

bool sdlGetWindowSafeArea(
  1. Pointer<SdlWindow> window,
  2. Pointer<SdlRect> rect
)

Get the safe area for this window.

Some devices have portions of the screen which are partially obscured or not interactive, possibly due to on-screen controls, curved edges, camera notches, TV overscan, etc. This function provides the area of the window which is safe to have interactable content. You should continue rendering into the rest of the window, but it should not contain visually important or interactible content.

\param window the window to query. \param rect a pointer filled in with the client area that is safe for interactive content. \returns true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

\since This function is available since SDL 3.1.3.

extern SDL_DECLSPEC bool SDLCALL SDL_GetWindowSafeArea(SDL_Window *window, SDL_Rect *rect)

Implementation

bool sdlGetWindowSafeArea(Pointer<SdlWindow> window, Pointer<SdlRect> rect) {
  final sdlGetWindowSafeAreaLookupFunction = libSdl3.lookupFunction<
      Uint8 Function(Pointer<SdlWindow> window, Pointer<SdlRect> rect),
      int Function(Pointer<SdlWindow> window,
          Pointer<SdlRect> rect)>('SDL_GetWindowSafeArea');
  return sdlGetWindowSafeAreaLookupFunction(window, rect) == 1;
}