Add letterbox/screen scaling support

2025-07-01 16:29:58 +09:00 · 2019-01-04 13:29:37 +09:00
parent 2fc10cb2bd
commit 3953f829c8
11 changed files with 228 additions and 31 deletions
--- a/osu.Game/Graphics/Containers/ScalingContainer.cs
+++ b/osu.Game/Graphics/Containers/ScalingContainer.cs
@ -0,0 +1,122 @@
+// Copyright (c) 2007-2019 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Framework.Allocation;
+using osu.Framework.Configuration;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Configuration;
+using osu.Game.Graphics.Backgrounds;
+using osuTK;
+
+namespace osu.Game.Graphics.Containers
+{
+    /// <summary>
+    /// Handles user-defined scaling, allowing application at multiple levels defined by <see cref="ScalingMode"/>.
+    /// </summary>
+    public class ScalingContainer : Container
+    {
+        private readonly bool isTopLevel;
+
+        private Bindable<float> sizeX;
+        private Bindable<float> sizeY;
+        private Bindable<float> posX;
+        private Bindable<float> posY;
+
+        private readonly ScalingMode targetMode;
+
+        private Bindable<ScalingMode> scalingMode;
+
+        private readonly Container content;
+        protected override Container<Drawable> Content => content;
+
+        private readonly Container sizableContainer;
+
+        private Drawable backgroundLayer;
+
+        /// <summary>
+        /// Create a new instance.
+        /// </summary>
+        /// <param name="targetMode">The mode which this container should be handling.</param>
+        public ScalingContainer(ScalingMode targetMode)
+        {
+            this.targetMode = targetMode;
+            RelativeSizeAxes = Axes.Both;
+
+            InternalChild = sizableContainer = new Container
+            {
+                RelativeSizeAxes = Axes.Both,
+                RelativePositionAxes = Axes.Both,
+                CornerRadius = 10,
+                Child = content = new DrawSizePreservingFillContainer()
+            };
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OsuConfigManager config)
+        {
+            scalingMode = config.GetBindable<ScalingMode>(OsuSetting.Scaling);
+            scalingMode.ValueChanged += _ => updateSize();
+
+            sizeX = config.GetBindable<float>(OsuSetting.ScalingSizeX);
+            sizeX.ValueChanged += _ => updateSize();
+
+            sizeY = config.GetBindable<float>(OsuSetting.ScalingSizeY);
+            sizeY.ValueChanged += _ => updateSize();
+
+            posX = config.GetBindable<float>(OsuSetting.ScalingPositionX);
+            posX.ValueChanged += _ => updateSize();
+
+            posY = config.GetBindable<float>(OsuSetting.ScalingPositionY);
+            posY.ValueChanged += _ => updateSize();
+        }
+
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            updateSize();
+            content.FinishTransforms();
+        }
+
+        private bool requiresBackgroundVisible => (scalingMode == ScalingMode.Everything || scalingMode == ScalingMode.ExcludeOverlays) && (sizeX.Value != 1 || sizeY.Value != 1);
+
+        private void updateSize()
+        {
+            if (targetMode == ScalingMode.Everything)
+            {
+                // the top level scaling container manages the background to be displayed while scaling.
+                if (requiresBackgroundVisible)
+                {
+                    if (backgroundLayer == null)
+                        LoadComponentAsync(backgroundLayer = new Background("Menu/menu-background-1")
+                        {
+                            Colour = OsuColour.Gray(0.1f),
+                            Alpha = 0,
+                            Depth = float.MaxValue
+                        }, d =>
+                        {
+                            AddInternal(d);
+                            d.FadeTo(requiresBackgroundVisible ? 1 : 0, 4000, Easing.OutQuint);
+                        });
+                    else
+                        backgroundLayer.FadeIn(500);
+                }
+                else
+                    backgroundLayer?.FadeOut(500);
+            }
+
+            bool letterbox = scalingMode.Value == targetMode;
+
+            var targetSize = letterbox ? new Vector2(sizeX, sizeY) : Vector2.One;
+            var targetPosition = letterbox ? new Vector2(posX, posY) * (Vector2.One - targetSize) : Vector2.Zero;
+            bool requiresMasking = targetSize != Vector2.One;
+
+            if (requiresMasking)
+                sizableContainer.Masking = true;
+
+            sizableContainer.MoveTo(targetPosition, 500, Easing.OutQuart);
+            sizableContainer.ResizeTo(targetSize, 500, Easing.OutQuart).OnComplete(_ => { content.Masking = requiresMasking; });
+        }
+    }
+}