Merge pull request #6193 from smoogipoo/disable-veldrid-gl

Remove Veldrid-OpenGL renderer, always use GLRenderer
ppy · Feb 20, 2024 · a8baecb · a8baecb
2 parents e7ffb59 + 29b5f04
commit a8baecb
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 10 deletions.
diff --git a/osu.Framework/Configuration/RendererType.cs b/osu.Framework/Configuration/RendererType.cs
@@ -1,7 +1,9 @@
 // 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;
 using System.ComponentModel;
+using osu.Framework.Graphics.OpenGL;
 
 namespace osu.Framework.Configuration
 {
@@ -19,9 +21,14 @@ public enum RendererType
         [Description("Direct3D 11")]
         Direct3D11,
 
+        /// <summary>
+        /// Uses <see cref="GLRenderer"/>.
+        /// </summary>
         [Description("OpenGL")]
         OpenGL,
 
+        // Can be removed 20240820
+        [Obsolete]
         [Description("OpenGL (Legacy)")]
         OpenGLLegacy,
     }

diff --git a/osu.Framework/Platform/GameHost.cs b/osu.Framework/Platform/GameHost.cs
@@ -857,15 +857,8 @@ public IEnumerable<RendererType> GetPreferredRenderersForCurrentPlatform()
             // See https://github.com/ppy/osu/issues/23003
             if (RuntimeInfo.OS != RuntimeInfo.Platform.iOS)
             {
-                // Non-veldrid "known-to-work".
-                yield return RendererType.OpenGLLegacy;
+                yield return RendererType.OpenGL;
             }
-
-            // Other available renderers should also be returned (to make this method usable as "all available renderers for current platform"),
-            // but will never be preferred as OpenGLLegacy will always work.
-            yield return RendererType.OpenGL;
-
-            if (!RuntimeInfo.IsApple) yield return RendererType.Vulkan;
         }
 
         protected virtual void ChooseAndSetupRenderer()
@@ -901,9 +894,12 @@ protected virtual void ChooseAndSetupRenderer()
             {
                 try
                 {
-                    if (type == RendererType.OpenGLLegacy)
-                        // the legacy renderer. this is basically guaranteed to support all platforms.
+                    if (type == RendererType.OpenGL)
+                    {
+                        // Use the legacy GL renderer. This is basically guaranteed to support all platforms
+                        // and performs better than the Veldrid-GL renderer due to reduction in allocs.
                         SetupRendererAndWindow("gl", GraphicsSurfaceType.OpenGL);
+                    }
                     else
                         SetupRendererAndWindow("veldrid", rendererToGraphicsSurfaceType(type));
 
@@ -1262,6 +1258,11 @@ protected virtual void SetupConfig(IDictionary<FrameworkSetting, object> default
             }, true);
 
             inputConfig = new InputConfigManager(Storage, AvailableInputHandlers);
+
+#pragma warning disable CS0612 // Type or member is obsolete
+            if (Config.Get<RendererType>(FrameworkSetting.Renderer) == RendererType.OpenGLLegacy)
+                Config.SetValue(FrameworkSetting.Renderer, RendererType.OpenGL);
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         /// <summary>