Merge pull request #6268 from Susko3/dont-overload-DisplayHandle

Refactor `DisplayHandle` into seperate android and linux properties

Author: smoogipoo

osu.Framework.Android/AndroidGameWindow.cs

@@ -9,7 +9,7 @@ namespace osu.Framework.Android
 {
     internal class AndroidGameWindow : SDL3MobileWindow
     {
-        public override IntPtr DisplayHandle => AndroidGameActivity.Surface.NativeSurface?.Handle ?? IntPtr.Zero;
+        public override IntPtr SurfaceHandle => AndroidGameActivity.Surface.NativeSurface?.Handle ?? IntPtr.Zero;
 
         public AndroidGameWindow(GraphicsSurfaceType surfaceType, string appName)
             : base(surfaceType, appName)

osu.Framework/Graphics/Veldrid/VeldridDevice.cs

@@ -162,15 +162,15 @@ public VeldridDevice(IGraphicsSurface graphicsSurface)
                 {
                     var linuxGraphics = (ILinuxGraphicsSurface)this.graphicsSurface;
                     swapchain.Source = linuxGraphics.IsWayland
-                        ? SwapchainSource.CreateWayland(this.graphicsSurface.DisplayHandle, this.graphicsSurface.WindowHandle)
-                        : SwapchainSource.CreateXlib(this.graphicsSurface.DisplayHandle, this.graphicsSurface.WindowHandle);
+                        ? SwapchainSource.CreateWayland(linuxGraphics.DisplayHandle, this.graphicsSurface.WindowHandle)
+                        : SwapchainSource.CreateXlib(linuxGraphics.DisplayHandle, this.graphicsSurface.WindowHandle);
                     break;
                 }
 
                 case RuntimeInfo.Platform.Android:
                 {
                     var androidGraphics = (IAndroidGraphicsSurface)this.graphicsSurface;
-                    swapchain.Source = SwapchainSource.CreateAndroidSurface(this.graphicsSurface.DisplayHandle, androidGraphics.JniEnvHandle);
+                    swapchain.Source = SwapchainSource.CreateAndroidSurface(androidGraphics.SurfaceHandle, androidGraphics.JniEnvHandle);
                     break;
                 }
             }

osu.Framework/Platform/IAndroidGraphicsSurface.cs

@@ -11,5 +11,11 @@ public interface IAndroidGraphicsSurface
         /// Returns JNI environment handle.
         /// </summary>
         IntPtr JniEnvHandle { get; }
+
+        /// <summary>
+        /// Android Surface handle.
+        /// </summary>
+        /// <remarks>https://developer.android.com/reference/android/view/Surface.html</remarks>
+        IntPtr SurfaceHandle { get; }
     }
 }

osu.Framework/Platform/IGraphicsSurface.cs

@@ -16,12 +16,6 @@ public interface IGraphicsSurface
         /// </summary>
         IntPtr WindowHandle { get; }
 
-        /// <summary>
-        /// A pointer representing a handle to the display containing this window, provided by the operating system.
-        /// This is specific to X11/Wayland subsystems.
-        /// </summary>
-        IntPtr DisplayHandle { get; }
-
         /// <summary>
         /// The type of surface.
         /// </summary>

osu.Framework/Platform/ILinuxGraphicsSurface.cs

@@ -1,6 +1,8 @@
 // Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
+
 namespace osu.Framework.Platform
 {
     public interface ILinuxGraphicsSurface
@@ -9,5 +11,11 @@ public interface ILinuxGraphicsSurface
         /// Whether the current display server is Wayland.
         /// </summary>
         bool IsWayland { get; }
+
+        /// <summary>
+        /// A pointer representing a handle to the display containing this window, provided by the operating system.
+        /// This is specific to X11/Wayland subsystems.
+        /// </summary>
+        IntPtr DisplayHandle { get; }
     }
 }

osu.Framework/Platform/SDL/SDL3GraphicsSurface.cs

@@ -21,7 +21,6 @@ internal unsafe class SDL3GraphicsSurface : IGraphicsSurface, IOpenGLGraphicsSur
         private IntPtr context;
 
         public IntPtr WindowHandle => window.WindowHandle;
-        public IntPtr DisplayHandle => window.DisplayHandle;
 
         public GraphicsSurfaceType Type { get; }
 
@@ -216,13 +215,19 @@ bool IOpenGLGraphicsSurface.VerticalSync
 
         bool ILinuxGraphicsSurface.IsWayland => window.IsWayland;
 
+        [SupportedOSPlatform("linux")]
+        IntPtr ILinuxGraphicsSurface.DisplayHandle => window.DisplayHandle;
+
         #endregion
 
         #region Android-specific implementation
 
         [SupportedOSPlatform("android")]
         IntPtr IAndroidGraphicsSurface.JniEnvHandle => SDL3.SDL_AndroidGetJNIEnv();
 
+        [SupportedOSPlatform("android")]
+        IntPtr IAndroidGraphicsSurface.SurfaceHandle => window.SurfaceHandle;
+
         #endregion
     }
 }

osu.Framework/Platform/SDL3Window.cs

@@ -5,6 +5,7 @@
 using System.IO;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
 using osu.Framework.Configuration;
@@ -119,7 +120,8 @@ public IntPtr WindowHandle
             }
         }
 
-        public virtual IntPtr DisplayHandle
+        [SupportedOSPlatform("linux")]
+        public IntPtr DisplayHandle
         {
             get
             {
@@ -138,6 +140,9 @@ public virtual IntPtr DisplayHandle
             }
         }
 
+        [SupportedOSPlatform("android")]
+        public virtual IntPtr SurfaceHandle => throw new PlatformNotSupportedException();
+
         public bool CapsLockPressed => SDL3.SDL_GetModState().HasFlagFast(SDL_Keymod.SDL_KMOD_CAPS);
 
         /// <summary>