Merge pull request #6669 from Susko3/tablet-pen-device-type-from-SDL

Propagate tablet pen device type from SDL

Author: smoogipoo

osu.Framework/Input/Handlers/Pen/PenHandler.cs

@@ -45,24 +45,20 @@ public override bool Initialize(GameHost host)
             return true;
         }
 
-        // Pen input is not necessarily direct on mobile platforms (specifically Android, where external tablets are supported),
-        // but until users experience issues with this, consider it "direct" for now.
-        private static readonly TabletPenDeviceType device_type = RuntimeInfo.IsMobile ? TabletPenDeviceType.Direct : TabletPenDeviceType.Unknown;
-
-        private void handlePenMove(Vector2 position, bool pressed)
+        private void handlePenMove(TabletPenDeviceType deviceType, Vector2 position, bool pressed)
         {
-            if (pressed && device_type == TabletPenDeviceType.Direct)
+            if (pressed && deviceType == TabletPenDeviceType.Direct)
                 enqueueInput(new TouchInput(new Input.Touch(TouchSource.PenTouch, position), true));
             else
-                enqueueInput(new MousePositionAbsoluteInputFromPen { DeviceType = device_type, Position = position });
+                enqueueInput(new MousePositionAbsoluteInputFromPen { DeviceType = deviceType, Position = position });
         }
 
-        private void handlePenTouch(bool pressed, Vector2 position)
+        private void handlePenTouch(TabletPenDeviceType deviceType, bool pressed, Vector2 position)
         {
-            if (device_type == TabletPenDeviceType.Direct)
+            if (deviceType == TabletPenDeviceType.Direct)
                 enqueueInput(new TouchInput(new Input.Touch(TouchSource.PenTouch, position), pressed));
             else
-                enqueueInput(new MouseButtonInputFromPen(pressed) { DeviceType = device_type });
+                enqueueInput(new MouseButtonInputFromPen(pressed) { DeviceType = deviceType });
         }
 
         private void handlePenButton(TabletPenButton button, bool pressed)

osu.Framework/Platform/SDL3/SDL3Extensions.cs

@@ -6,6 +6,7 @@
 using osu.Framework.Graphics.Primitives;
 using osu.Framework.Input;
 using osu.Framework.Input.Bindings;
+using osu.Framework.Input.StateChanges;
 using osuTK.Input;
 using SDL;
 using static SDL.SDL3;
@@ -1048,6 +1049,21 @@ public static unsafe DisplayMode ToDisplayMode(this SDL_DisplayMode mode, int di
             return new DisplayMode(SDL_GetPixelFormatName(mode.format), new Size(mode.w, mode.h), bpp, mode.refresh_rate, displayIndex);
         }
 
+        public static TabletPenDeviceType ToTabletPenDeviceType(this SDL_PenDeviceType type)
+        {
+            switch (type)
+            {
+                case SDL_PenDeviceType.SDL_PEN_DEVICE_TYPE_DIRECT:
+                    return TabletPenDeviceType.Direct;
+
+                case SDL_PenDeviceType.SDL_PEN_DEVICE_TYPE_INDIRECT:
+                    return TabletPenDeviceType.Indirect;
+
+                default:
+                    return TabletPenDeviceType.Unknown;
+            }
+        }
+
         public static string ReadableName(this SDL_LogCategory category)
         {
             switch (category)

osu.Framework/Platform/SDL3/SDL3Window_Input.cs

@@ -11,6 +11,7 @@
 using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Graphics.Primitives;
 using osu.Framework.Input;
+using osu.Framework.Input.StateChanges;
 using osu.Framework.Input.States;
 using osu.Framework.Logging;
 using osuTK;
@@ -530,14 +531,16 @@ private void handleKeyboardEvent(SDL_KeyboardEvent evtKey)
 
         private void handleKeymapChangedEvent() => KeymapChanged?.Invoke();
 
+        private static TabletPenDeviceType getPenType(SDL_PenID instanceID) => SDL_GetPenDeviceType(instanceID).ToTabletPenDeviceType();
+
         private void handlePenMotionEvent(SDL_PenMotionEvent evtPenMotion)
         {
-            PenMove?.Invoke(new Vector2(evtPenMotion.x, evtPenMotion.y) * Scale, evtPenMotion.pen_state.HasFlagFast(SDL_PenInputFlags.SDL_PEN_INPUT_DOWN));
+            PenMove?.Invoke(getPenType(evtPenMotion.which), new Vector2(evtPenMotion.x, evtPenMotion.y) * Scale, evtPenMotion.pen_state.HasFlagFast(SDL_PenInputFlags.SDL_PEN_INPUT_DOWN));
         }
 
         private void handlePenTouchEvent(SDL_PenTouchEvent evtPenTouch)
         {
-            PenTouch?.Invoke(evtPenTouch.down, new Vector2(evtPenTouch.x, evtPenTouch.y) * Scale);
+            PenTouch?.Invoke(getPenType(evtPenTouch.which), evtPenTouch.down, new Vector2(evtPenTouch.x, evtPenTouch.y) * Scale);
         }
 
         /// <summary>
@@ -745,13 +748,13 @@ private void updateConfineMode()
         /// <summary>
         /// Invoked when a pen moves. Passes pen position and whether the pen is touching the tablet surface.
         /// </summary>
-        public event Action<Vector2, bool>? PenMove;
+        public event Action<TabletPenDeviceType, Vector2, bool>? PenMove;
 
         /// <summary>
         /// Invoked when a pen touches (<c>true</c>) or lifts (<c>false</c>) from the tablet surface.
         /// Also passes the current position of the pen.
         /// </summary>
-        public event Action<bool, Vector2>? PenTouch;
+        public event Action<TabletPenDeviceType, bool, Vector2>? PenTouch;
 
         /// <summary>
         /// Invoked when a <see cref="TabletPenButton">pen button</see> is pressed (<c>true</c>) or released (<c>false</c>).

osu.Framework/osu.Framework.csproj

@@ -38,7 +38,7 @@
     <PackageReference Include="ppy.osuTK.NS20" Version="1.0.211" />
     <PackageReference Include="StbiSharp" Version="1.1.0" />
     <PackageReference Include="ppy.SDL2-CS" Version="1.0.741-alpha" />
-    <PackageReference Include="ppy.SDL3-CS" Version="2025.920.0" />
+    <PackageReference Include="ppy.SDL3-CS" Version="2025.1115.0" />
     <PackageReference Include="ppy.osu.Framework.SourceGeneration" Version="2024.1128.0" />
 
     <!-- DO NOT use ProjectReference for native packaging project.