(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetWindowSafeArea

Get the safe area for this window.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

bool SDL_GetWindowSafeArea(SDL_Window *window, SDL_Rect *rect);

Function Parameters

SDL_Window *	window	the window to query.
SDL_Rect *	rect	a pointer filled in with the client area that is safe for interactive content.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryVideo

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.