Merge pull request #23038 from cdwcgt/scale-background-dim

Add feature to adjust `ScalingContainer` background dim

osu.Game/Configuration/OsuConfigManager.cs

@@ -157,6 +157,7 @@ namespace osu.Game.Configuration
 
             SetDefault(OsuSetting.Scaling, ScalingMode.Off);
             SetDefault(OsuSetting.SafeAreaConsiderations, true);
+            SetDefault(OsuSetting.ScalingBackgroundDim, 0.9f, 0.5f, 1f);
 
             SetDefault(OsuSetting.ScalingSizeX, 0.8f, 0.2f, 1f);
             SetDefault(OsuSetting.ScalingSizeY, 0.8f, 0.2f, 1f);
@@ -364,6 +365,7 @@ namespace osu.Game.Configuration
         ScalingPositionY,
         ScalingSizeX,
         ScalingSizeY,
+        ScalingBackgroundDim,
         UIScale,
         IntroSequence,
         NotifyOnUsernameMentioned,

osu.Game/Graphics/Containers/ScalingContainer.cs

@@ -15,6 +15,7 @@ using osu.Game.Configuration;
 using osu.Game.Screens;
 using osu.Game.Screens.Backgrounds;
 using osuTK;
+using osuTK.Graphics;
 
 namespace osu.Game.Graphics.Containers
 {
@@ -46,6 +47,8 @@ namespace osu.Game.Graphics.Containers
 
         private BackgroundScreenStack backgroundStack;
 
+        private Bindable<float> scalingMenuBackgroundDim;
+
         private RectangleF? customRect;
         private bool customRectIsRelativePosition;
 
@@ -138,6 +141,9 @@ namespace osu.Game.Graphics.Containers
 
             safeAreaPadding = safeArea.SafeAreaPadding.GetBoundCopy();
             safeAreaPadding.BindValueChanged(_ => Scheduler.AddOnce(updateSize));
+
+            scalingMenuBackgroundDim = config.GetBindable<float>(OsuSetting.ScalingBackgroundDim);
+            scalingMenuBackgroundDim.ValueChanged += _ => Scheduler.AddOnce(updateSize);
         }
 
         protected override void LoadComplete()
@@ -148,7 +154,9 @@ namespace osu.Game.Graphics.Containers
             sizableContainer.FinishTransforms();
         }
 
-        private bool requiresBackgroundVisible => (scalingMode.Value == ScalingMode.Everything || scalingMode.Value == ScalingMode.ExcludeOverlays) && (sizeX.Value != 1 || sizeY.Value != 1);
+        private bool requiresBackgroundVisible => (scalingMode.Value == ScalingMode.Everything || scalingMode.Value == ScalingMode.ExcludeOverlays)
+                                                  && (sizeX.Value != 1 || sizeY.Value != 1)
+                                                  && scalingMenuBackgroundDim.Value < 1;
 
         private void updateSize()
         {
@@ -161,8 +169,8 @@ namespace osu.Game.Graphics.Containers
                     {
                         AddInternal(backgroundStack = new BackgroundScreenStack
                         {
-                            Colour = OsuColour.Gray(0.1f),
                             Alpha = 0,
+                            Colour = Color4.Black,
                             Depth = float.MaxValue
                         });
 
@@ -170,6 +178,7 @@ namespace osu.Game.Graphics.Containers
                     }
 
                     backgroundStack.FadeIn(TRANSITION_DURATION);
+                    backgroundStack.FadeColour(OsuColour.Gray(1.0f - scalingMenuBackgroundDim.Value), TRANSITION_DURATION, Easing.OutQuint);
                 }
                 else
                     backgroundStack?.FadeOut(TRANSITION_DURATION);

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

@@ -30,6 +30,7 @@ namespace osu.Game.Overlays.Settings.Sections.Graphics
         protected override LocalisableString Header => GraphicsSettingsStrings.LayoutHeader;
 
         private FillFlowContainer<SettingsSlider<float>> scalingSettings = null!;
+        private SettingsSlider<float> dimSlider = null!;
 
         private readonly Bindable<Display> currentDisplay = new Bindable<Display>();
 
@@ -57,6 +58,8 @@ namespace osu.Game.Overlays.Settings.Sections.Graphics
         private Bindable<float> scalingSizeX = null!;
         private Bindable<float> scalingSizeY = null!;
 
+        private Bindable<float> scalingBackgroundDim = null!;
+
         private const int transition_duration = 400;
 
         [BackgroundDependencyLoader]
@@ -70,6 +73,7 @@ namespace osu.Game.Overlays.Settings.Sections.Graphics
             scalingSizeY = osuConfig.GetBindable<float>(OsuSetting.ScalingSizeY);
             scalingPositionX = osuConfig.GetBindable<float>(OsuSetting.ScalingPositionX);
             scalingPositionY = osuConfig.GetBindable<float>(OsuSetting.ScalingPositionY);
+            scalingBackgroundDim = osuConfig.GetBindable<float>(OsuSetting.ScalingBackgroundDim);
 
             if (window != null)
             {
@@ -161,6 +165,13 @@ namespace osu.Game.Overlays.Settings.Sections.Graphics
                             KeyboardStep = 0.01f,
                             DisplayAsPercentage = true
                         },
+                        dimSlider = new SettingsSlider<float>
+                        {
+                            LabelText = GameplaySettingsStrings.BackgroundDim,
+                            Current = scalingBackgroundDim,
+                            KeyboardStep = 0.01f,
+                            DisplayAsPercentage = true,
+                        },
                     }
                 },
             };
@@ -216,8 +227,15 @@ namespace osu.Game.Overlays.Settings.Sections.Graphics
                 scalingSettings.AutoSizeAxes = scalingMode.Value != ScalingMode.Off ? Axes.Y : Axes.None;
                 scalingSettings.ForEach(s =>
                 {
-                    s.TransferValueOnCommit = scalingMode.Value == ScalingMode.Everything;
+                    if (s == dimSlider)
-                    s.CanBeShown.Value = scalingMode.Value != ScalingMode.Off;
+                    {
+                        s.CanBeShown.Value = scalingMode.Value == ScalingMode.Everything || scalingMode.Value == ScalingMode.ExcludeOverlays;
+                    }
+                    else
+                    {
+                        s.TransferValueOnCommit = scalingMode.Value == ScalingMode.Everything;
+                        s.CanBeShown.Value = scalingMode.Value != ScalingMode.Off;
+                    }
                 });
             }
         }