Merge pull request #22924 from peppy/add-renderer-selection

Add ability to select renderer

Author: bdach

osu.Game/Localisation/GraphicsSettingsStrings.cs

@@ -19,6 +19,11 @@ public static class GraphicsSettingsStrings
         /// </summary>
         public static LocalisableString RendererHeader => new TranslatableString(getKey(@"renderer_header"), @"Renderer");
 
+        /// <summary>
+        /// "Renderer"
+        /// </summary>
+        public static LocalisableString Renderer => new TranslatableString(getKey(@"renderer"), @"Renderer");
+
         /// <summary>
         /// "Frame limiter"
         /// </summary>
@@ -144,6 +149,12 @@ public static class GraphicsSettingsStrings
         /// </summary>
         public static LocalisableString Png => new TranslatableString(getKey(@"png_lossless"), @"PNG (lossless)");
 
+        /// <summary>
+        /// "In order to change the renderer, the game will close. Please open it again."
+        /// </summary>
+        public static LocalisableString ChangeRendererConfirmation =>
+            new TranslatableString(getKey(@"change_renderer_configuration"), @"In order to change the renderer, the game will close. Please open it again.");
+
         private static string getKey(string key) => $"{prefix}:{key}";
     }
 }

osu.Game/Overlays/Settings/Sections/Graphics/RendererSettings.cs

@@ -1,28 +1,44 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-#nullable disable
-
+using System.Linq;
+using osu.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Configuration;
+using osu.Framework.Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Localisation;
 using osu.Framework.Platform;
 using osu.Game.Configuration;
+using osu.Game.Graphics.UserInterface;
 using osu.Game.Localisation;
+using osu.Game.Overlays.Dialog;
 
 namespace osu.Game.Overlays.Settings.Sections.Graphics
 {
     public partial class RendererSettings : SettingsSubsection
     {
         protected override LocalisableString Header => GraphicsSettingsStrings.RendererHeader;
 
+        private bool automaticRendererInUse;
+
         [BackgroundDependencyLoader]
-        private void load(FrameworkConfigManager config, OsuConfigManager osuConfig)
+        private void load(FrameworkConfigManager config, OsuConfigManager osuConfig, IDialogOverlay? dialogOverlay, OsuGame? game, GameHost host)
         {
-            // NOTE: Compatability mode omitted
+            var renderer = config.GetBindable<RendererType>(FrameworkSetting.Renderer);
+            automaticRendererInUse = renderer.Value == RendererType.Automatic;
+
+            SettingsEnumDropdown<RendererType> rendererDropdown;
+
             Children = new Drawable[]
             {
+                rendererDropdown = new RendererSettingsDropdown
+                {
+                    LabelText = GraphicsSettingsStrings.Renderer,
+                    Current = renderer,
+                    Items = host.GetPreferredRenderersForCurrentPlatform().OrderBy(t => t),
+                    Keywords = new[] { @"compatibility", @"directx" },
+                },
                 // TODO: this needs to be a custom dropdown at some point
                 new SettingsEnumDropdown<FrameSync>
                 {
@@ -41,6 +57,55 @@ private void load(FrameworkConfigManager config, OsuConfigManager osuConfig)
                     Current = osuConfig.GetBindable<bool>(OsuSetting.ShowFpsDisplay)
                 },
             };
+
+            renderer.BindValueChanged(r =>
+            {
+                if (r.NewValue == host.ResolvedRenderer)
+                    return;
+
+                // Need to check startup renderer for the "automatic" case, as ResolvedRenderer above will track the final resolved renderer instead.
+                if (r.NewValue == RendererType.Automatic && automaticRendererInUse)
+                    return;
+
+                dialogOverlay?.Push(new ConfirmDialog(GraphicsSettingsStrings.ChangeRendererConfirmation, () => game?.AttemptExit(), () =>
+                {
+                    renderer.Value = automaticRendererInUse ? RendererType.Automatic : host.ResolvedRenderer;
+                }));
+            });
+
+            // TODO: remove this once we support SDL+android.
+            if (RuntimeInfo.OS == RuntimeInfo.Platform.Android)
+            {
+                rendererDropdown.Items = new[] { RendererType.Automatic, RendererType.OpenGLLegacy };
+                rendererDropdown.SetNoticeText("New renderer support for android is coming soon!", true);
+            }
+        }
+
+        private partial class RendererSettingsDropdown : SettingsEnumDropdown<RendererType>
+        {
+            protected override OsuDropdown<RendererType> CreateDropdown() => new RendererDropdown();
+
+            protected partial class RendererDropdown : DropdownControl
+            {
+                private RendererType hostResolvedRenderer;
+                private bool automaticRendererInUse;
+
+                [BackgroundDependencyLoader]
+                private void load(FrameworkConfigManager config, GameHost host)
+                {
+                    var renderer = config.GetBindable<RendererType>(FrameworkSetting.Renderer);
+                    automaticRendererInUse = renderer.Value == RendererType.Automatic;
+                    hostResolvedRenderer = host.ResolvedRenderer;
+                }
+
+                protected override LocalisableString GenerateItemText(RendererType item)
+                {
+                    if (item == RendererType.Automatic && automaticRendererInUse)
+                        return LocalisableString.Interpolate($"{base.GenerateItemText(item)} ({hostResolvedRenderer.GetDescription()})");
+
+                    return base.GenerateItemText(item);
+                }
+            }
         }
     }
 }