From 31229fd47f5d38282ead8ff27c2f2c8b8b9e0a56 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Fri, 15 Sep 2023 09:49:43 -0400
Subject: [PATCH] include: Added a note about SDL's iOS app delegate functions.
Fixes #8250.
---
include/SDL3/SDL_system.h | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/include/SDL3/SDL_system.h b/include/SDL3/SDL_system.h
index f0366b7083e0..8b9539b98254 100644
--- a/include/SDL3/SDL_system.h
+++ b/include/SDL3/SDL_system.h
@@ -582,7 +582,16 @@ extern DECLSPEC SDL_WinRT_DeviceFamily SDLCALL SDL_WinRTGetDeviceFamily();
*/
extern DECLSPEC SDL_bool SDLCALL SDL_IsTablet(void);
-/* Functions used by iOS application delegates to notify SDL about state changes */
+/* Functions used by iOS app delegates to notify SDL about state changes.
+ *
+ * These functions allow iOS apps that have their own event handling to hook
+ * into SDL to generate SDL events. These map directly to iOS-specific
+ * events, but since they don't do anything iOS-specific internally, they
+ * are available on all platforms, in case they might be useful for some
+ * specific paradigm. Most apps do not need to use these directly; SDL's
+ * internal event code will handle all this for windows created by
+ * SDL_CreateWindow!
+ */
/*
* \since This function is available since SDL 3.0.0.