Browse Source

Document renamed API functions in SDL_keyboard.h

Sam Lantinga 2 years ago
parent
commit
0901657278
2 changed files with 17 additions and 0 deletions
  1. 7 0
      docs/README-migration.md
  2. 10 0
      include/SDL3/SDL_oldnames.h

+ 7 - 0
docs/README-migration.md

@@ -361,6 +361,13 @@ The following functions have been removed:
 * SDL_JoystickPathForIndex() - replaced with SDL_GetJoystickInstancePath()
 * SDL_NumJoysticks - replaced with SDL_GetJoysticks()
  
+## SDL_keyboard.h
+
+The following functions have been renamed:
+* SDL_IsScreenKeyboardShown() => SDL_ScreenKeyboardShown()
+* SDL_IsTextInputActive() => SDL_TextInputActive()
+* SDL_IsTextInputShown() => SDL_TextInputShown()
+
 ## SDL_keycode.h
 
 The following symbols have been renamed:

+ 10 - 0
include/SDL3/SDL_oldnames.h

@@ -219,6 +219,11 @@
 #define SDL_JoystickUpdate SDL_UpdateJoysticks
 #define SDL_NumJoysticks SDL_GetNumJoysticks
 
+/* ##SDL_keyboard.h */
+#define SDL_IsScreenKeyboardShown SDL_ScreenKeyboardShown
+#define SDL_IsTextInputActive SDL_TextInputActive
+#define SDL_IsTextInputShown SDL_TextInputShown
+
 /* ##SDL_keycode.h */
 #define KMOD_ALT SDL_KMOD_ALT
 #define KMOD_CAPS SDL_KMOD_CAPS
@@ -526,6 +531,11 @@
 #define SDL_JoystickSetVirtualHat SDL_JoystickSetVirtualHat_renamed_SDL_SetJoystickVirtualHat
 #define SDL_JoystickUpdate SDL_JoystickUpdate_renamed_SDL_UpdateJoysticks
 
+/* ##SDL_keyboard.h */
+#define SDL_IsScreenKeyboardShown SDL_IsScreenKeyboardShown_renamed_SDL_ScreenKeyboardShown
+#define SDL_IsTextInputActive SDL_IsTextInputActive_renamed_SDL_TextInputActive
+#define SDL_IsTextInputShown SDL_IsTextInputShown_renamed_SDL_TextInputShown
+
 /* ##SDL_keycode.h */
 #define KMOD_ALT KMOD_ALT_renamed_SDL_KMOD_ALT
 #define KMOD_CAPS KMOD_CAPS_renamed_SDL_KMOD_CAPS