Commit 6d4991b87b53f26b38b21648059552d1e2a5b4d1

Sam Lantinga 2021-05-07T12:28:53

Merge commit 'f309d0649d37022ad49bc468c77dd87bf82f261b' into main

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/SDL_video.h b/include/SDL_video.h
index 41c3e10..0c05a09 100644
--- a/include/SDL_video.h
+++ b/include/SDL_video.h
@@ -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
  * 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.
  *
  * \param window the window to query the size values of the border