Add maximum dimensions limit to skinnable gameplay elements

osu.Game.Rulesets.Catch/Skinning/Legacy/LegacyBananaPiece.cs

@@ -2,17 +2,21 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Graphics.Textures;
+using osu.Game.Skinning;
+using osuTK;
 
 namespace osu.Game.Rulesets.Catch.Skinning.Legacy
 {
     public partial class LegacyBananaPiece : LegacyCatchHitObjectPiece
     {
+        private static readonly Vector2 banana_max_size = new Vector2(128);
+
         protected override void LoadComplete()
         {
             base.LoadComplete();
 
-            Texture? texture = Skin.GetTexture("fruit-bananas");
-            Texture? overlayTexture = Skin.GetTexture("fruit-bananas-overlay");
+            Texture? texture = Skin.GetTexture("fruit-bananas")?.WithMaximumSize(banana_max_size);
+            Texture? overlayTexture = Skin.GetTexture("fruit-bananas-overlay")?.WithMaximumSize(banana_max_size);
 
             SetTexture(texture, overlayTexture);
         }

osu.Game.Rulesets.Catch/Skinning/Legacy/LegacyDropletPiece.cs

@@ -2,12 +2,15 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Graphics.Textures;
+using osu.Game.Skinning;
 using osuTK;
 
 namespace osu.Game.Rulesets.Catch.Skinning.Legacy
 {
     public partial class LegacyDropletPiece : LegacyCatchHitObjectPiece
     {
+        private static readonly Vector2 droplet_max_size = new Vector2(100);
+
         public LegacyDropletPiece()
         {
             Scale = new Vector2(0.8f);
@@ -17,8 +20,8 @@ protected override void LoadComplete()
         {
             base.LoadComplete();
 
-            Texture? texture = Skin.GetTexture("fruit-drop");
-            Texture? overlayTexture = Skin.GetTexture("fruit-drop-overlay");
+            Texture? texture = Skin.GetTexture("fruit-drop")?.WithMaximumSize(droplet_max_size);
+            Texture? overlayTexture = Skin.GetTexture("fruit-drop-overlay")?.WithMaximumSize(droplet_max_size);
 
             SetTexture(texture, overlayTexture);
         }

osu.Game.Rulesets.Catch/Skinning/Legacy/LegacyFruitPiece.cs

@@ -2,11 +2,15 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Game.Rulesets.Catch.Objects;
+using osu.Game.Skinning;
+using osuTK;
 
 namespace osu.Game.Rulesets.Catch.Skinning.Legacy
 {
     internal partial class LegacyFruitPiece : LegacyCatchHitObjectPiece
     {
+        private static readonly Vector2 fruit_max_size = new Vector2(128);
+
         protected override void LoadComplete()
         {
             base.LoadComplete();
@@ -22,19 +26,19 @@ private void setTexture(FruitVisualRepresentation visualRepresentation)
             switch (visualRepresentation)
             {
                 case FruitVisualRepresentation.Pear:
-                    SetTexture(Skin.GetTexture("fruit-pear"), Skin.GetTexture("fruit-pear-overlay"));
+                    SetTexture(Skin.GetTexture("fruit-pear")?.WithMaximumSize(fruit_max_size), Skin.GetTexture("fruit-pear-overlay")?.WithMaximumSize(fruit_max_size));
                     break;
 
                 case FruitVisualRepresentation.Grape:
-                    SetTexture(Skin.GetTexture("fruit-grapes"), Skin.GetTexture("fruit-grapes-overlay"));
+                    SetTexture(Skin.GetTexture("fruit-grapes")?.WithMaximumSize(fruit_max_size), Skin.GetTexture("fruit-grapes-overlay")?.WithMaximumSize(fruit_max_size));
                     break;
 
                 case FruitVisualRepresentation.Pineapple:
-                    SetTexture(Skin.GetTexture("fruit-apple"), Skin.GetTexture("fruit-apple-overlay"));
+                    SetTexture(Skin.GetTexture("fruit-apple")?.WithMaximumSize(fruit_max_size), Skin.GetTexture("fruit-apple-overlay")?.WithMaximumSize(fruit_max_size));
                     break;
 
                 case FruitVisualRepresentation.Raspberry:
-                    SetTexture(Skin.GetTexture("fruit-orange"), Skin.GetTexture("fruit-orange-overlay"));
+                    SetTexture(Skin.GetTexture("fruit-orange")?.WithMaximumSize(fruit_max_size), Skin.GetTexture("fruit-orange-overlay")?.WithMaximumSize(fruit_max_size));
                     break;
             }
         }

osu.Game.Rulesets.Osu/Skinning/Legacy/LegacyMainCirclePiece.cs

@@ -21,6 +21,8 @@ namespace osu.Game.Rulesets.Osu.Skinning.Legacy
 {
     public partial class LegacyMainCirclePiece : CompositeDrawable
     {
+        private static readonly Vector2 circle_piece_size = new Vector2(OsuHitObject.OBJECT_RADIUS * 2);
+
         public override bool RemoveCompletedTransforms => false;
 
         /// <summary>
@@ -51,7 +53,7 @@ public LegacyMainCirclePiece(string? priorityLookupPrefix = null, bool hasNumber
             this.priorityLookupPrefix = priorityLookupPrefix;
             this.hasNumber = hasNumber;
 
-            Size = new Vector2(OsuHitObject.OBJECT_RADIUS * 2);
+            Size = circle_piece_size;
         }
 
         [BackgroundDependencyLoader]
@@ -68,7 +70,7 @@ private void load()
             // expected behaviour in this scenario is not showing the overlay, rather than using hitcircleoverlay.png.
             InternalChildren = new[]
             {
-                CircleSprite = new LegacyKiaiFlashingDrawable(() => new Sprite { Texture = skin.GetTexture(circleName) })
+                CircleSprite = new LegacyKiaiFlashingDrawable(() => new Sprite { Texture = skin.GetTexture(circleName)?.WithMaximumSize(circle_piece_size) })
                 {
                     Anchor = Anchor.Centre,
                     Origin = Anchor.Centre,
@@ -77,7 +79,7 @@ private void load()
                 {
                     Anchor = Anchor.Centre,
                     Origin = Anchor.Centre,
-                    Child = OverlaySprite = new LegacyKiaiFlashingDrawable(() => skin.GetAnimation(@$"{circleName}overlay", true, true, frameLength: 1000 / 2d))
+                    Child = OverlaySprite = new LegacyKiaiFlashingDrawable(() => skin.GetAnimation(@$"{circleName}overlay", true, true, frameLength: 1000 / 2d, maxSize: circle_piece_size))
                     {
                         Anchor = Anchor.Centre,
                         Origin = Anchor.Centre,

osu.Game.Rulesets.Taiko/Skinning/Legacy/LegacyCirclePiece.cs

@@ -22,6 +22,8 @@ namespace osu.Game.Rulesets.Taiko.Skinning.Legacy
 {
     public partial class LegacyCirclePiece : CompositeDrawable, IHasAccentColour
     {
+        private static readonly Vector2 circle_piece_size = new Vector2(128);
+
         private Drawable backgroundLayer = null!;
         private Drawable? foregroundLayer;
 
@@ -52,9 +54,9 @@ private void load(ISkinSource skin, DrawableHitObject drawableHitObject, IBeatSy
 
                 string prefix = ((drawableHitObject.HitObject as TaikoStrongableHitObject)?.IsStrong ?? false) ? big_hit : normal_hit;
 
-                return skin.GetAnimation($"{prefix}{lookup}", true, false) ??
+                return skin.GetAnimation($"{prefix}{lookup}", true, false, maxSize: circle_piece_size) ??
                        // fallback to regular size if "big" version doesn't exist.
-                       skin.GetAnimation($"{normal_hit}{lookup}", true, false);
+                       skin.GetAnimation($"{normal_hit}{lookup}", true, false, maxSize: circle_piece_size);
             }
 
             // backgroundLayer is guaranteed to exist due to the pre-check in TaikoLegacySkinTransformer.
@@ -96,7 +98,7 @@ protected override void Update()
             // Not all skins (including the default osu-stable) have similar sizes for "hitcircle" and "hitcircleoverlay".
             // This ensures they are scaled relative to each other but also match the expected DrawableHit size.
             foreach (var c in InternalChildren)
-                c.Scale = new Vector2(DrawHeight / 128);
+                c.Scale = new Vector2(DrawHeight / circle_piece_size.Y);
 
             if (foregroundLayer is IFramedAnimation animatableForegroundLayer)
                 animateForegroundLayer(animatableForegroundLayer);

osu.Game.Rulesets.Taiko/Skinning/Legacy/LegacyDrumRoll.cs

@@ -9,6 +9,7 @@
 using osu.Framework.Graphics.Textures;
 using osu.Game.Graphics;
 using osu.Game.Skinning;
+using osuTK;
 using osuTK.Graphics;
 
 namespace osu.Game.Rulesets.Taiko.Skinning.Legacy
@@ -47,13 +48,13 @@ private void load(ISkinSource skin, OsuColour colours)
                     Anchor = Anchor.CentreRight,
                     Origin = Anchor.CentreLeft,
                     RelativeSizeAxes = Axes.Both,
-                    Texture = skin.GetTexture("taiko-roll-end", WrapMode.ClampToEdge, WrapMode.ClampToEdge),
+                    Texture = skin.GetTexture("taiko-roll-end", WrapMode.ClampToEdge, WrapMode.ClampToEdge)?.WithMaximumSize(new Vector2(128, 256)),
                     FillMode = FillMode.Fit,
                 },
                 body = new Sprite
                 {
                     RelativeSizeAxes = Axes.Both,
-                    Texture = skin.GetTexture("taiko-roll-middle", WrapMode.ClampToEdge, WrapMode.ClampToEdge),
+                    Texture = skin.GetTexture("taiko-roll-middle", WrapMode.ClampToEdge, WrapMode.ClampToEdge)?.WithMaximumSize(new Vector2(2, 256)),
                 },
                 headCircle = new LegacyCirclePiece
                 {

osu.Game.Tests/Visual/Gameplay/TestSceneGameplayElementDimensions.cs

@@ -0,0 +1,73 @@
+// 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.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics.Textures;
+using osu.Framework.Testing;
+using osu.Game.IO;
+using osu.Game.Rulesets;
+using osu.Game.Screens.Play;
+using osu.Game.Skinning;
+
+namespace osu.Game.Tests.Visual.Gameplay
+{
+    public partial class TestSceneGameplayElementDimensions : TestSceneAllRulesetPlayers
+    {
+        protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
+        {
+            var dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
+
+            // for now this only applies to legacy skins, as modern skins don't have texture-based gameplay elements yet.
+            dependencies.CacheAs<ISkinSource>(new UpscaledLegacySkin(dependencies.Get<SkinManager>()));
+
+            return dependencies;
+        }
+
+        protected override void AddCheckSteps()
+        {
+        }
+
+        protected override Player CreatePlayer(Ruleset ruleset)
+        {
+            var player = base.CreatePlayer(ruleset);
+            player.OnLoadComplete += _ =>
+            {
+                // this test scene focuses on gameplay elements, so let's hide the hud.
+                var hudOverlay = player.ChildrenOfType<HUDOverlay>().Single();
+                hudOverlay.ShowHud.Value = false;
+                hudOverlay.ShowHud.Disabled = true;
+            };
+            return player;
+        }
+
+        private class UpscaledLegacySkin : DefaultLegacySkin, ISkinSource
+        {
+            public UpscaledLegacySkin(IStorageResourceProvider resources)
+                : base(resources)
+            {
+            }
+
+            public event Action? SourceChanged
+            {
+                add { }
+                remove { }
+            }
+
+            public override Texture? GetTexture(string componentName, WrapMode wrapModeS, WrapMode wrapModeT)
+            {
+                var texture = base.GetTexture(componentName, wrapModeS, wrapModeT);
+
+                if (texture != null)
+                    texture.ScaleAdjust /= 5f;
+
+                return texture;
+            }
+
+            public ISkin? FindProvider(Func<ISkin, bool> lookupFunction) => this;
+            public IEnumerable<ISkin> AllSources => new[] { this };
+        }
+    }
+}

osu.Game/Skinning/IAnimationTimeReference.cs

@@ -5,6 +5,7 @@
 using osu.Framework.Bindables;
 using osu.Framework.Graphics.Textures;
 using osu.Framework.Timing;
+using osuTK;
 
 namespace osu.Game.Skinning
 {
@@ -13,7 +14,7 @@ namespace osu.Game.Skinning
     /// </summary>
     /// <remarks>
     /// This should not be used to start an animation immediately at the current time.
-    /// To do so, use <see cref="LegacySkinExtensions.GetAnimation(ISkin, string, WrapMode, WrapMode, bool, bool, bool, string, bool, double?)"/> with <code>startAtCurrentTime = true</code> instead.
+    /// To do so, use <see cref="LegacySkinExtensions.GetAnimation(ISkin, string, WrapMode, WrapMode, bool, bool, bool, string, bool, double?, Vector2?)"/> with <code>startAtCurrentTime = true</code> instead.
     /// </remarks>
     [Cached]
     public interface IAnimationTimeReference

osu.Game/Skinning/LegacySkinExtensions.cs

@@ -11,23 +11,24 @@
 using osu.Framework.Graphics.Animations;
 using osu.Framework.Graphics.Sprites;
 using osu.Framework.Graphics.Textures;
+using osuTK;
 using static osu.Game.Skinning.SkinConfiguration;
 
 namespace osu.Game.Skinning
 {
     public static partial class LegacySkinExtensions
     {
         public static Drawable? GetAnimation(this ISkin? source, string componentName, bool animatable, bool looping, bool applyConfigFrameRate = false, string animationSeparator = "-",
-                                             bool startAtCurrentTime = true, double? frameLength = null)
-            => source.GetAnimation(componentName, default, default, animatable, looping, applyConfigFrameRate, animationSeparator, startAtCurrentTime, frameLength);
+                                             bool startAtCurrentTime = true, double? frameLength = null, Vector2? maxSize = null)
+            => source.GetAnimation(componentName, default, default, animatable, looping, applyConfigFrameRate, animationSeparator, startAtCurrentTime, frameLength, maxSize);
 
         public static Drawable? GetAnimation(this ISkin? source, string componentName, WrapMode wrapModeS, WrapMode wrapModeT, bool animatable, bool looping, bool applyConfigFrameRate = false,
-                                             string animationSeparator = "-", bool startAtCurrentTime = true, double? frameLength = null)
+                                             string animationSeparator = "-", bool startAtCurrentTime = true, double? frameLength = null, Vector2? maxSize = null)
         {
             if (source == null)
                 return null;
 
-            var textures = GetTextures(source, componentName, wrapModeS, wrapModeT, animatable, animationSeparator, out var retrievalSource);
+            var textures = GetTextures(source, componentName, wrapModeS, wrapModeT, animatable, animationSeparator, maxSize, out var retrievalSource);
 
             switch (textures.Length)
             {
@@ -53,7 +54,7 @@ public static partial class LegacySkinExtensions
             }
         }
 
-        public static Texture[] GetTextures(this ISkin? source, string componentName, WrapMode wrapModeS, WrapMode wrapModeT, bool animatable, string animationSeparator, out ISkin? retrievalSource)
+        public static Texture[] GetTextures(this ISkin? source, string componentName, WrapMode wrapModeS, WrapMode wrapModeT, bool animatable, string animationSeparator, Vector2? maxSize, out ISkin? retrievalSource)
         {
             retrievalSource = null;
 
@@ -80,6 +81,9 @@ public static Texture[] GetTextures(this ISkin? source, string componentName, Wr
             // if an animation was not allowed or not found, fall back to a sprite retrieval.
             var singleTexture = retrievalSource.GetTexture(componentName, wrapModeS, wrapModeT);
 
+            if (singleTexture != null && maxSize != null)
+                singleTexture = singleTexture.WithMaximumSize(maxSize.Value);
+
             return singleTexture != null
                 ? new[] { singleTexture }
                 : Array.Empty<Texture>();
@@ -88,18 +92,31 @@ IEnumerable<Texture> getTextures(ISkin skin)
             {
                 for (int i = 0; true; i++)
                 {
-                    Texture? texture;
+                    var texture = skin.GetTexture(getFrameName(i), wrapModeS, wrapModeT);
 
-                    if ((texture = skin.GetTexture(getFrameName(i), wrapModeS, wrapModeT)) == null)
+                    if (texture == null)
                         break;
 
+                    if (maxSize != null)
+                        texture = texture.WithMaximumSize(maxSize.Value);
+
                     yield return texture;
                 }
             }
 
             string getFrameName(int frameIndex) => $"{componentName}{animationSeparator}{frameIndex}";
         }
 
+        public static Texture WithMaximumSize(this Texture texture, Vector2 maxSize)
+        {
+            if (texture.DisplayWidth <= maxSize.X && texture.DisplayHeight <= maxSize.Y)
+                return texture;
+
+            // use scale adjust property for downscaling the texture in order to meet the specified maximum dimensions.
+            texture.ScaleAdjust *= Math.Max(texture.DisplayWidth / maxSize.X, texture.DisplayHeight / maxSize.Y);
+            return texture;
+        }
+
         public static bool HasFont(this ISkin source, LegacyFont font)
         {
             return source.GetTexture($"{source.GetFontPrefix(font)}-0") != null;

osu.Game/Storyboards/Drawables/DrawableStoryboardAnimation.cs

@@ -137,7 +137,7 @@ private void skinSourceChanged()
 
             // When reading from a skin, we match stables weird behaviour where `FrameCount` is ignored
             // and resources are retrieved until the end of the animation.
-            foreach (var texture in skin.GetTextures(Path.GetFileNameWithoutExtension(Animation.Path)!, default, default, true, string.Empty, out _))
+            foreach (var texture in skin.GetTextures(Path.GetFileNameWithoutExtension(Animation.Path)!, default, default, true, string.Empty, null, out _))
                 AddFrame(texture, Animation.FrameDelay);
         }