From cae90ef4899e97870c943281a1f128a9e3409ab0 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Sat, 13 Apr 2024 18:38:11 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
---
include/SDL3/SDL_system.h | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/include/SDL3/SDL_system.h b/include/SDL3/SDL_system.h
index a684d07708776..880bc5e6936b4 100644
--- a/include/SDL3/SDL_system.h
+++ b/include/SDL3/SDL_system.h
@@ -165,8 +165,6 @@ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID,
#ifdef SDL_PLATFORM_IOS
/**
- * Use this function to set the animation callback on Apple iOS.
- *
* The function prototype for `callback` is:
*
* ```c
@@ -174,13 +172,16 @@ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID,
* ```
*
* Where its parameter, `callbackParam`, is what was passed as `callbackParam`
- * to SDL_iOSSetAnimationCallback().
+ * to SDL_iPhoneSetAnimationCallback().
*
* This function is only available on Apple iOS.
*
* For more information see:
* https://github.com/libsdl-org/SDL/blob/main/docs/README-ios.md
*
+ * This functions is also accessible using the macro
+ * SDL_iOSSetAnimationCallback() since SDL 2.0.4.
+ *
* \param window the window for which the animation callback should be set
* \param interval the number of frames after which **callback** will be
* called
@@ -191,7 +192,7 @@ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID,
*
* \since This function is available since SDL 3.0.0.
*
- * \sa SDL_iOSSetEventPump
+ * \sa SDL_iPhoneSetEventPump
*/
extern DECLSPEC int SDLCALL SDL_iOSSetAnimationCallback(SDL_Window * window, int interval, void (SDLCALL *callback)(void*), void *callbackParam);