sdlGetRenderSafeArea function

bool sdlGetRenderSafeArea(
  1. Pointer<SdlRenderer> renderer,
  2. Pointer<SdlRect> rect
)

Get the safe area for rendering within the current viewport.

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 current viewport which is safe to have interactible content. You should continue rendering into the rest of the render target, but it should not contain visually important or interactible content.

\param renderer the rendering context. \param rect a pointer filled in with the 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_GetRenderSafeArea(SDL_Renderer *renderer, SDL_Rect *rect)

Implementation

bool sdlGetRenderSafeArea(
    Pointer<SdlRenderer> renderer, Pointer<SdlRect> rect) {
  final sdlGetRenderSafeAreaLookupFunction = libSdl3.lookupFunction<
      Uint8 Function(Pointer<SdlRenderer> renderer, Pointer<SdlRect> rect),
      int Function(Pointer<SdlRenderer> renderer,
          Pointer<SdlRect> rect)>('SDL_GetRenderSafeArea');
  return sdlGetRenderSafeAreaLookupFunction(renderer, rect) == 1;
}