geemili
/
SDL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

include: Document timing issue with SDL_GetWindowBordersSize

main
Ethan Lee 2021-05-04 11:23:54 -04:00 committed by Ryan C. Gordon
parent 58884e4c1b
commit f309d0649d
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/SDL_video.h
View File

@ -893,6 +893,12 @@ extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
* initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the * initialized to 0, 0, 0, 0 (if a non-NULL pointer is provided), as if the
* window in question was borderless. * window in question was borderless.
* *
* Note: This function may fail on systems where the window has not yet been
* decorated by the display server (for example, immediately after calling
* SDL_CreateWindow). It is recommended that you wait at least until the
* window has been presented and composited, so that the window system has a
* chance to decorate the window and provide the border dimensions to SDL.
*
* This function also returns -1 if getting the information is not supported. * This function also returns -1 if getting the information is not supported.
* *
* \param window the window to query the size values of the border * \param window the window to query the size values of the border