Rename functions in SDL_system.h to match SDL 3.0 naming convention

Fixes https://github.com/libsdl-org/SDL/issues/10277
2026-04-28 02:04:20 +00:00 · 2024-07-15 16:13:23 -07:00
parent e38f971f46
commit 54366181c3
32 changed files with 252 additions and 158 deletions
--- a/include/SDL3/SDL_oldnames.h
+++ b/include/SDL3/SDL_oldnames.h
@@ -599,9 +599,22 @@
 #define SDL_UpperBlitScaled SDL_BlitSurfaceScaled

 /* ##SDL_system.h */
-#define SDL_WinRTGetFSPathUTF8 SDL_WinRTGetFSPath
-#define SDL_iPhoneSetAnimationCallback SDL_iOSSetAnimationCallback
-#define SDL_iPhoneSetEventPump SDL_iOSSetEventPump
+#define SDL_AndroidGetActivity SDL_GetAndroidActivity
+#define SDL_AndroidGetExternalStoragePath SDL_GetAndroidExternalStoragePath
+#define SDL_AndroidGetExternalStorageState SDL_GetAndroidExternalStorageState
+#define SDL_AndroidGetInternalStoragePath SDL_GetAndroidInternalStoragePath
+#define SDL_AndroidGetJNIEnv SDL_GetAndroidJNIEnv
+#define SDL_Direct3D9GetAdapterIndex SDL_GetDirect3D9AdapterIndex
+#define SDL_GDKGetDefaultUser SDL_GetGDKDefaultUser
+#define SDL_GDKGetTaskQueue SDL_GetGDKTaskQueue
+#define SDL_LinuxSetThreadPriority SDL_SetLinuxThreadPriority
+#define SDL_LinuxSetThreadPriorityAndPolicy SDL_SetLinuxThreadPriorityAndPolicy
+#define SDL_WinRTGetDeviceFamily SDL_GetWinRTDeviceFamily
+#define SDL_GetWinRTFSPathUTF8 SDL_GetWinRTFSPath
+#define SDL_iOSSetAnimationCallback SDL_SetiOSAnimationCallback
+#define SDL_iOSSetEventPump SDL_SetiOSEventPump
+#define SDL_iPhoneSetAnimationCallback SDL_SetiOSAnimationCallback
+#define SDL_iPhoneSetEventPump SDL_SetiOSEventPump

 /* ##SDL_thread.h */
 #define SDL_TLSCleanup SDL_CleanupTLS
@@ -1197,7 +1210,20 @@
 #define SDL_UpperBlitScaled SDL_UpperBlitScaled_renamed_SDL_BlitSurfaceScaled

 /* ##SDL_system.h */
-#define SDL_WinRTGetFSPathUTF8 SDL_WinRTGetFSPathUTF8_renamed_SDL_WinRTGetFSPath
+#define SDL_AndroidGetActivity SDL_AndroidGetActivity_renamed_SDL_GetAndroidActivity
+#define SDL_AndroidGetExternalStoragePath SDL_AndroidGetExternalStoragePath_renamed_SDL_GetAndroidExternalStoragePath
+#define SDL_AndroidGetExternalStorageState SDL_AndroidGetExternalStorageState_renamed_SDL_GetAndroidExternalStorageState
+#define SDL_AndroidGetInternalStoragePath SDL_AndroidGetInternalStoragePath_renamed_SDL_GetAndroidInternalStoragePath
+#define SDL_AndroidGetJNIEnv SDL_AndroidGetJNIEnv_renamed_SDL_GetAndroidJNIEnv
+#define SDL_Direct3D9GetAdapterIndex SDL_Direct3D9GetAdapterIndex_renamed_SDL_GetDirect3D9AdapterIndex
+#define SDL_GDKGetDefaultUser SDL_GDKGetDefaultUser_renamed_SDL_GetGDKDefaultUser
+#define SDL_GDKGetTaskQueue SDL_GDKGetTaskQueue_renamed_SDL_GetGDKTaskQueue
+#define SDL_LinuxSetThreadPriority SDL_LinuxSetThreadPriority_renamed_SDL_SetLinuxThreadPriority
+#define SDL_LinuxSetThreadPriorityAndPolicy SDL_LinuxSetThreadPriorityAndPolicy_renamed_SDL_SetLinuxThreadPriorityAndPolicy
+#define SDL_WinRTGetDeviceFamily SDL_WinRTGetDeviceFamily_renamed_SDL_GetWinRTDeviceFamily
+#define SDL_GetWinRTFSPathUTF8 SDL_GetWinRTFSPathUTF8_renamed_SDL_GetWinRTFSPath
+#define SDL_iOSSetAnimationCallback SDL_iOSSetAnimationCallback_renamed_SDL_SetiOSAnimationCallback
+#define SDL_iOSSetEventPump SDL_iOSSetEventPump_renamed_SDL_SetiOSEventPump
 #define SDL_iPhoneSetAnimationCallback SDL_iPhoneSetAnimationCallback_renamed_SDL_iOSSetAnimationCallback
 #define SDL_iPhoneSetEventPump SDL_iPhoneSetEventPump_renamed_SDL_iOSSetEventPump

--- a/include/SDL3/SDL_system.h
+++ b/include/SDL3/SDL_system.h
@@ -106,7 +106,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHoo
 *
 * \since This function is available since SDL 3.0.0.
 */
-extern SDL_DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex(SDL_DisplayID displayID);
+extern SDL_DECLSPEC int SDLCALL SDL_GetDirect3D9AdapterIndex(SDL_DisplayID displayID);

 #endif /* defined(SDL_PLATFORM_WIN32) || defined(SDL_PLATFORM_WINGDK) */

@@ -166,7 +166,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetX11EventHook(SDL_X11EventHook callback,
 *
 * \since This function is available since SDL 3.0.0.
 */
-extern SDL_DECLSPEC int SDLCALL SDL_LinuxSetThreadPriority(Sint64 threadID, int priority);
+extern SDL_DECLSPEC int SDLCALL SDL_SetLinuxThreadPriority(Sint64 threadID, int priority);

 /**
 * Sets the priority (not nice level) and scheduling policy for a thread.
@@ -182,7 +182,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_LinuxSetThreadPriority(Sint64 threadID, int
 *
 * \since This function is available since SDL 3.0.0.
 */
-extern SDL_DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threadID, int sdlPriority, int schedPolicy);
+extern SDL_DECLSPEC int SDLCALL SDL_SetLinuxThreadPriorityAndPolicy(Sint64 threadID, int sdlPriority, int schedPolicy);

 #endif /* SDL_PLATFORM_LINUX */

@@ -197,15 +197,15 @@ extern SDL_DECLSPEC int SDLCALL SDL_LinuxSetThreadPriorityAndPolicy(Sint64 threa
 * This datatype is only useful on Apple iOS.
 *
 * After passing a function pointer of this type to
- * SDL_iOSSetAnimationCallback, the system will call that function pointer at
+ * SDL_SetiOSAnimationCallback, the system will call that function pointer at
 * a regular interval.
 *
 * \param userdata what was passed as `callbackParam` to
- *                 SDL_iOSSetAnimationCallback as `callbackParam`.
+ *                 SDL_SetiOSAnimationCallback as `callbackParam`.
 *
 * \since This datatype is available since SDL 3.0.0.
 *
- * \sa SDL_iOSSetAnimationCallback
+ * \sa SDL_SetiOSAnimationCallback
 */
 typedef void (SDLCALL *SDL_iOSAnimationCallback)(void *userdata);

@@ -219,7 +219,7 @@ typedef void (SDLCALL *SDL_iOSAnimationCallback)(void *userdata);
 * ```
 *
 * Where its parameter, `callbackParam`, is what was passed as `callbackParam`
- * to SDL_iOSSetAnimationCallback().
+ * to SDL_SetiOSAnimationCallback().
 *
 * This function is only available on Apple iOS.
 *
@@ -244,9 +244,9 @@ typedef void (SDLCALL *SDL_iOSAnimationCallback)(void *userdata);
 *
 * \since This function is available since SDL 3.0.0.
 *
- * \sa SDL_iOSSetEventPump
+ * \sa SDL_SetiOSEventPump
 */
-extern SDL_DECLSPEC int SDLCALL SDL_iOSSetAnimationCallback(SDL_Window * window, int interval, SDL_iOSAnimationCallback callback, void *callbackParam);
+extern SDL_DECLSPEC int SDLCALL SDL_SetiOSAnimationCallback(SDL_Window * window, int interval, SDL_iOSAnimationCallback callback, void *callbackParam);

 /**
 * Use this function to enable or disable the SDL event pump on Apple iOS.
@@ -257,9 +257,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_iOSSetAnimationCallback(SDL_Window * window,
 *
 * \since This function is available since SDL 3.0.0.
 *
- * \sa SDL_iOSSetAnimationCallback
+ * \sa SDL_SetiOSAnimationCallback
 */
-extern SDL_DECLSPEC void SDLCALL SDL_iOSSetEventPump(SDL_bool enabled);
+extern SDL_DECLSPEC void SDLCALL SDL_SetiOSEventPump(SDL_bool enabled);

 #endif /* SDL_PLATFORM_IOS */

@@ -286,9 +286,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_iOSSetEventPump(SDL_bool enabled);
 *
 * \since This function is available since SDL 3.0.0.
 *
- * \sa SDL_AndroidGetActivity
+ * \sa SDL_GetAndroidActivity
 */
-extern SDL_DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv(void);
+extern SDL_DECLSPEC void * SDLCALL SDL_GetAndroidJNIEnv(void);

 /**
 * Retrieve the Java instance of the Android activity class.
@@ -310,9 +310,9 @@ extern SDL_DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv(void);
 *
 * \since This function is available since SDL 3.0.0.
 *
- * \sa SDL_AndroidGetJNIEnv
+ * \sa SDL_GetAndroidJNIEnv
 */
-extern SDL_DECLSPEC void * SDLCALL SDL_AndroidGetActivity(void);
+extern SDL_DECLSPEC void * SDLCALL SDL_GetAndroidActivity(void);

 /**
 * Query Android API level of the current device.
@@ -414,9 +414,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_AndroidBackButton(void);
 *
 * \since This function is available since SDL 3.0.0.
 *
- * \sa SDL_AndroidGetExternalStorageState
+ * \sa SDL_GetAndroidExternalStorageState
 */
-extern SDL_DECLSPEC const char *SDLCALL SDL_AndroidGetInternalStoragePath(void);
+extern SDL_DECLSPEC const char *SDLCALL SDL_GetAndroidInternalStoragePath(void);

 /**
 * Get the current state of external storage for this Android application.
@@ -433,9 +433,9 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_AndroidGetInternalStoragePath(void);
 *
 * \since This function is available since SDL 3.0.0.
 *
- * \sa SDL_AndroidGetExternalStoragePath
+ * \sa SDL_GetAndroidExternalStoragePath
 */
-extern SDL_DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState(Uint32 *state);
+extern SDL_DECLSPEC int SDLCALL SDL_GetAndroidExternalStorageState(Uint32 *state);

 /**
 * Get the path used for external storage for this Android application.
@@ -457,9 +457,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState(Uint32 *state
 *
 * \since This function is available since SDL 3.0.0.
 *
- * \sa SDL_AndroidGetExternalStorageState
+ * \sa SDL_GetAndroidExternalStorageState
 */
-extern SDL_DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath(void);
+extern SDL_DECLSPEC const char * SDLCALL SDL_GetAndroidExternalStoragePath(void);

 /**
 * Get the path used for caching data for this Android application.
@@ -480,7 +480,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath(void)
 *
 * \since This function is available since SDL 3.0.0.
 */
-extern SDL_DECLSPEC const char * SDLCALL SDL_AndroidGetCachePath(void);
+extern SDL_DECLSPEC const char * SDLCALL SDL_GetAndroidCachePath(void);


 typedef void (SDLCALL *SDL_AndroidRequestPermissionCallback)(void *userdata, const char *permission, SDL_bool granted);
@@ -636,7 +636,7 @@ typedef enum SDL_WinRT_DeviceFamily
 *
 * \since This function is available since SDL 3.0.0.
 */
-extern SDL_DECLSPEC const char * SDLCALL SDL_WinRTGetFSPath(SDL_WinRT_Path pathType);
+extern SDL_DECLSPEC const char * SDLCALL SDL_GetWinRTFSPath(SDL_WinRT_Path pathType);

 /**
 * Detects the device family of WinRT platform at runtime.
@@ -645,7 +645,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_WinRTGetFSPath(SDL_WinRT_Path pathT
 *
 * \since This function is available since SDL 3.0.0.
 */
-extern SDL_DECLSPEC SDL_WinRT_DeviceFamily SDLCALL SDL_WinRTGetDeviceFamily();
+extern SDL_DECLSPEC SDL_WinRT_DeviceFamily SDLCALL SDL_GetWinRTDeviceFamily();

 #endif /* SDL_PLATFORM_WINRT */

@@ -805,7 +805,7 @@ typedef struct XUser *XUserHandle;
 *
 * \since This function is available since SDL 3.0.0.
 */
-extern SDL_DECLSPEC int SDLCALL SDL_GDKGetTaskQueue(XTaskQueueHandle * outTaskQueue);
+extern SDL_DECLSPEC int SDLCALL SDL_GetGDKTaskQueue(XTaskQueueHandle * outTaskQueue);

 /**
 * Gets a reference to the default user handle for GDK.
@@ -819,7 +819,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GDKGetTaskQueue(XTaskQueueHandle * outTaskQu
 *
 * \since This function is available since SDL 3.0.0.
 */
-extern SDL_DECLSPEC int SDLCALL SDL_GDKGetDefaultUser(XUserHandle * outUserHandle);
+extern SDL_DECLSPEC int SDLCALL SDL_GetGDKDefaultUser(XUserHandle * outUserHandle);

 #endif