Mark Key.IMESelected obsolete

Author: bmalrat

Assets/Tests/InputSystem/APIVerificationTests.cs

@@ -556,6 +556,8 @@ public class DualShock4GamepadHID : DualShockGamepad
     ")]
     // KeyboardState state size has increased to support more keys like F13-F24
     [ScopedExclusionProperty("1.0.0", "UnityEngine.InputSystem.LowLevel", "public struct KeyboardState : IInputStateTypeInfo", "public fixed byte keys[14];")]
+    // Allow Key.IMESelected to be marked as Obsolete
+    [ScopedExclusionProperty("1.0.0", "UnityEngine.InputSystem", "public enum Key", "IMESelected = 111,")]
     public void API_MinorVersionsHaveNoBreakingChanges()
     {
         var currentVersion = CoreTests.PackageJson.ReadVersion();

Assets/Tests/InputSystem/CorePerformanceTests.cs

@@ -126,7 +126,7 @@ public void Performance_ReadEveryKey()
             int keyIndex = 0;
             foreach (var key in keyboard.allKeys)
             {
-                if (++keyIndex == (int)Key.IMESelected)  // Skip IMESelected as it's not a real key.
+                if (++keyIndex == (int)KeyEx.IMESelected)  // Skip IMESelected as it's not a real key.
                     continue;
                 key.ReadValue();
             }

Assets/Tests/InputSystem/CoreTests_Devices.cs

@@ -2683,6 +2683,7 @@ public void Devices_AnyKeyOnKeyboard_DoesNotReactToIMESelected()
 
     [Test]
     [Category("Devices")]
+    [Obsolete("Test obsolete IMESelected Key")]
     public void Devices_ImeSelectedKeyOnKeyboard_SupportObsoleteIMESelectedKey()
     {
         var keyboard = InputSystem.AddDevice<Keyboard>();

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -10,6 +10,12 @@ however, it has to be formatted properly to pass verification tests.
 
 ## [Unreleased] - yyyy-mm-dd
 
+### Changed
+- Changed enum value `Key.IMESelected` to obsolete which was not a real key. Please use the ButtonControl `imeSelected`.
+
+### Added
+- Added support of F13-F24 keys. [UUM-44328](https://issuetracker.unity3d.com/product/unity/issues/guid/UUM-44328)
+
 ## [1.13.1] - 2025-02-18
 
 ### Fixed
@@ -22,9 +28,6 @@ however, it has to be formatted properly to pass verification tests.
 ### Changed
 - Changed default input action asset name from New Controls to New Actions.
 
-### Added
-- Added support of F13-F24 keys. [UUM-44328](https://issuetracker.unity3d.com/product/unity/issues/guid/UUM-44328)
-
 ## [1.13.0] - 2025-02-05
 
 ### Fixed

Packages/com.unity.inputsystem/InputSystem/Devices/Keyboard.cs

@@ -207,7 +207,7 @@ public KeyboardState(bool IMESelected, params Key[] pressedKeys)
 
                 if (IMESelected)
                 {
-                    MemoryHelpers.WriteSingleBit(keysPtr, (uint)Key.IMESelected, true);
+                    MemoryHelpers.WriteSingleBit(keysPtr, (uint)KeyEx.IMESelected, true);
                 }
 
                 for (var i = 0; i < pressedKeys.Length; ++i)
@@ -906,6 +906,7 @@ public enum Key
         /// Don't use this. This is a dummy key that is only used internally to represent the IME selected state.
         /// Will be removed in the future.
         /// </summary>
+        [Obsolete("IMESelected is a dummy key and will be removed in the future. Please use ButtonControl imeSelected")]
         IMESelected,
 
         /// <summary>
@@ -979,7 +980,8 @@ public enum Key
 
     internal static class KeyEx
     {
-        internal const Key RemappedIMESelected = (Key)127; //IMESelected value
+        internal const Key IMESelected = (Key)111; // Key.IMESelected value
+        internal const Key RemappedIMESelected = (Key)127; // Remapped to the end of buffer of Key InternalForIMESelected
     }
 
     /// <summary>
@@ -2679,9 +2681,9 @@ unsafe bool IEventPreProcessor.PreProcessEvent(InputEventPtr currentEventPtr)
                 if (stateEvent->stateFormat == KeyboardState.Format)
                 {
                     var keyboardState = ((KeyboardState*)(stateEvent->stateData));
-                    if (keyboardState->Get(Key.IMESelected))
+                    if (keyboardState->Get(KeyEx.IMESelected))
                     {
-                        keyboardState->Set(Key.IMESelected, false);
+                        keyboardState->Set(KeyEx.IMESelected, false);
                         keyboardState->Set(KeyEx.RemappedIMESelected, true);
                     }
                 }

Packages/com.unity.inputsystem/InputSystem/InputExtensions.cs

@@ -145,7 +145,7 @@ public static bool IsTextInputKey(this Key key)
                 case Key.OEM3:
                 case Key.OEM4:
                 case Key.OEM5:
-                case Key.IMESelected:
+                case KeyEx.IMESelected:
                     return false;
             }
             return true;