From 9c5ae7293f33c85c715c1509685bbcf92a713a4a Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Sat, 13 Apr 2024 18:59:10 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
---
include/SDL3/SDL_system.h | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/include/SDL3/SDL_system.h b/include/SDL3/SDL_system.h
index 880bc5e6936b4..a684d07708776 100644
--- a/include/SDL3/SDL_system.h
+++ b/include/SDL3/SDL_system.h
@@ -165,6 +165,8 @@ 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
@@ -172,16 +174,13 @@ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID,
* ```
*
* Where its parameter, `callbackParam`, is what was passed as `callbackParam`
- * to SDL_iPhoneSetAnimationCallback().
+ * to SDL_iOSSetAnimationCallback().
*
* 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
@@ -192,7 +191,7 @@ extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID,
*
* \since This function is available since SDL 3.0.0.
*
- * \sa SDL_iPhoneSetEventPump
+ * \sa SDL_iOSSetEventPump
*/
extern DECLSPEC int SDLCALL SDL_iOSSetAnimationCallback(SDL_Window * window, int interval, void (SDLCALL *callback)(void*), void *callbackParam);