SDL_GetWindowSafeArea - Get the safe area for this window.
Contents
Availability
This function is available since SDL 3.2.0.
Simple Directmedia Layer SDL 3.2.10 SDL_GetWindowSafeArea(3)
Description
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.
Function Parameters
window the window to query.
rect a pointer filled in with the client area that is safe for interactive content.
Header File
Defined in SDL3/SDL_video.h
Name
SDL_GetWindowSafeArea - Get the safe area for this window.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Synopsis
#include"SDL3/SDL.h"boolSDL_GetWindowSafeArea(SDL_Window*window,SDL_Rect*rect);
Thread Safety
This function should only be called on the main thread.
