From 56d7cc7a025b2a30042ba773f4bd49b8140f6a50 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Sat, 4 Jan 2025 03:47:21 -0500
Subject: [PATCH] SDL_video.h: Added a note about platform quirks to
SDL_DestroyWindow docs.
Fixes #10081.
---
include/SDL3/SDL_video.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h
index cb74ed865eb80..00b98b33088f7 100644
--- a/include/SDL3/SDL_video.h
+++ b/include/SDL3/SDL_video.h
@@ -2788,6 +2788,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOp
* Any child windows owned by the window will be recursively destroyed as
* well.
*
+ * Note that on some platforms, the visible window may not actually be removed
+ * from the screen until the SDL event loop is pumped again, even though the
+ * SDL_Window is no longer valid after this call.
+ *
* \param window the window to destroy.
*
* \threadsafety This function should only be called on the main thread.