Add "Background scale mode" setting by diquoks · Pull Request #36111 · ppy/osu

diquoks · 2025-12-22T22:37:52Z

a slightly better version with localisation and code quality

nagi-desuuu · 2025-12-23T06:47:33Z

Reminder that this setting should also be in First run setup as well.

peppy · 2025-12-26T10:12:19Z

osu.Game/Screens/Backgrounds/BackgroundScreenBeatmap.cs

+            fillMode = config.GetBindable<BackgroundFillMode>(OsuSetting.BackgroundFillMode);
+            fillMode.BindValueChanged(_ => loadBeatmapBackground(beatmap));


Why is this change handling done here as opposed to inside BeatmapBackground?

Also, we never put BindValueChanged inside BDL methods as it is thread unsafe.

it's really strange, don't remember why i did this, maybe something didn't work before that

should i use BindValueChanged inside LoadComplete instead?

Yes, but also consider not reloading the whole beatmap to update the mode. I think the can be removed and handled exclusively in BeatmapBackground.

diquoks · 2025-12-26T11:07:51Z

osu.Game/Graphics/Backgrounds/BeatmapBackground.cs

+        {
+            base.LoadComplete();
+
+            fillMode.ValueChanged += _ => updateBackgroundFillMode();


now, BindValueChanged doesn't seem to work properly during and after playing beatmap
@peppy what could be the reason for this?

2025-12-26.13-53-45.mp4

No one in their right mind would want this.

peppy · 2025-12-29T10:22:37Z

@bdach if you want to give this 5 minutes that would be appreciated, since i changed over 50%.

diquoks · 2025-12-29T11:07:26Z

since i changed over 50%.

didn't want to cause problems, i'm just not very familiar with the codebase yet 🙌

peppy · 2025-12-29T11:11:49Z

didn't want to cause problems, i'm just not very familiar with the codebase yet 🙌

it's fine, didn't mean it like that. just a standard practice that we get an extra review in such cases.

bdach · 2025-12-29T11:14:20Z

This looks wonky in song select when progressing from main menu:

Screen.Recording.2025-12-29.at.12.12.23.mov

Note left side of screen, where the old background from main menu is visible where the "letterbox" would be until it insta-fades out.

peppy · 2025-12-29T11:25:36Z

Right, probably need to invoke some fake letterboxing boxes to fix that, which is going to be less fun.

peppy · 2026-01-05T07:06:40Z

osu.Game/Graphics/Backgrounds/Background.cs

            this.textureName = textureName;
            RelativeSizeAxes = Axes.Both;

+            AddInternal(Letterbox = new Box


This results in a performance regression, due to overdrawing of layers.

Check something like LetterboxOverlay for how this needs to be done.

Should not result in any boxes unless required (ie. for fill screen it shouldn't be required).

This results in a performance regression, due to overdrawing of layers.

Check something like LetterboxOverlay for how this needs to be done.

Should not result in any boxes unless required (ie. for fill screen it shouldn't be required).

should be resolved in d2203d1

diquoks · 2026-01-12T09:43:46Z

osu.Game/Graphics/Backgrounds/BeatmapBackground.cs

                case BackgroundScaleMode.ScaleToFit:
                    Sprite.FillMode = FillMode.Fit;
+
+                    letterboxWidth.Value = (DrawWidth - Sprite.DrawWidth) / DrawWidth;


couldn't get this to work with RelativeSizeAxes

peppy · 2026-01-13T07:31:16Z

I can't find a test scene covering this, how are you testing?

I specifically want a test so i can check the different scale modes and make sure there's no visible gap between the letterbox and the background.

diquoks · 2026-01-13T07:36:10Z

I can't find a test scene covering this, how are you testing?

I specifically want a test so i can check the different scale modes and make sure there's no visible gap between the letterbox and the background.

i was just changing the setting and watching the changes in SSV2, also using ctrl+f1

i'm not quite used to using visual tests yet, but i can try to write something when i get home

peppy · 2026-01-13T07:47:18Z

Checking in song select likely hides some issues in edge case scenarios, so having a test scene would be good. Let me know if you have issues making it work.

peppy · 2026-01-16T11:01:07Z

osu.Game.Tests/Visual/Background/TestSceneBackgroundScreenDefault.cs

        }

+        [Test]
+        public void TestBackgroundScaleModeSwitch()


The test doesn't show any changes visually. Nor does it run to completion in interactive mode.

Nor does it run to completion in interactive mode.

it was fine for me but after some tests i realised that it might fail because of this line

AddUntilStep("default background fill mode is fill", () => getCurrentBackground()?.Sprite.FillMode == FillMode.Fill);

because the "default background fill mode" may actually change after reading the game.ini

The test doesn't show any changes visually.

there were also visual changes but now i decided to make them more visible

addressed in 218f113

diquoks · 2026-01-18T09:51:34Z

osu.Game/Graphics/Backgrounds/BeatmapBackground.cs

+            Box leftLetterbox;
+            Box rightLetterbox;
+            Box topLetterbox;
+            Box bottomLetterbox;
+
+            AddInternal(new Container
+            {
+                RelativeSizeAxes = Axes.Both,
+                Children = new Drawable[]
+                {
+                    leftLetterbox = new Box
+                    {
+                        Anchor = Anchor.CentreLeft,
+                        Origin = Anchor.CentreLeft,
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = Color4.Black,
+                    },
+                    rightLetterbox = new Box
+                    {
+                        Anchor = Anchor.CentreRight,
+                        Origin = Anchor.CentreRight,
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = Color4.Black,
+                    },
+                    topLetterbox = new Box
+                    {
+                        Anchor = Anchor.TopCentre,
+                        Origin = Anchor.TopCentre,
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = Color4.Black,
+                    },
+                    bottomLetterbox = new Box
+                    {
+                        Anchor = Anchor.BottomCentre,
+                        Origin = Anchor.BottomCentre,
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = Color4.Black,
+                    }
+                }
+            });
+
+            letterboxWidth.BindValueChanged(margin =>
+            {
+                leftLetterbox.ResizeWidthTo(margin.NewValue);
+                rightLetterbox.ResizeWidthTo(margin.NewValue);
+            }, true);
+
+            letterboxHeight.BindValueChanged(margin =>
+            {
+                topLetterbox.ResizeHeightTo(margin.NewValue);
+                bottomLetterbox.ResizeHeightTo(margin.NewValue);
+            }, true);


don't really like how it's written now but can't write any better yet

also need to figure something out with updating the letterboxes after window's resizing, as this kind of incident may occur

Add "Background fill mode" setting

170cf92

pull-request-size bot added the size/M label Dec 22, 2025

diquoks mentioned this pull request Dec 22, 2025

Add background scaling mode setting #36109

Closed

Add ClassicDefault to "Background fill mode" setting

6f00fb8

peppy reviewed Dec 26, 2025

View reviewed changes

Attempt to transfer BackgroundFillMode logic in BeatmapBackground

d9289f2

diquoks commented Dec 26, 2025

View reviewed changes

peppy self-requested a review December 29, 2025 05:52

peppy added 2 commits December 29, 2025 17:29

Fix scale mode not updating when blur is involved

a7bb959

Remove "stretch to fill"

54c62cc

No one in their right mind would want this.

pull-request-size bot added size/L and removed size/M labels Dec 29, 2025

Update copy to read better

fb76d8d

pull-request-size bot added size/M and removed size/L labels Dec 29, 2025

peppy added the area:gameplay label Dec 29, 2025

Simplify bindable handling

30addce

peppy previously approved these changes Dec 29, 2025

View reviewed changes

Rename "fillMode" occurrences to "scaleMode"

e7948b6

diquoks dismissed peppy’s stale review via e7948b6 December 29, 2025 11:05

diquoks changed the title ~~Add "Background fill mode" setting~~ Add "Background scale mode" setting Dec 29, 2025

Privatise setter

82c78d6

Add letterbox to Background

a2db390

pull-request-size bot removed the size/M label Jan 4, 2026

pull-request-size bot added the size/L label Jan 4, 2026

diquoks requested a review from peppy January 4, 2026 14:33

peppy requested changes Jan 5, 2026

View reviewed changes

Move letterbox to BeatmapBackground

d2203d1

diquoks requested a review from peppy January 12, 2026 09:42

diquoks commented Jan 12, 2026

View reviewed changes

Remove default width

9104332

Add test coverage

7459dc0

diquoks force-pushed the quick-fix/background-fill-mode-setting branch from 36534c8 to 7459dc0 Compare January 14, 2026 23:51

peppy requested changes Jan 16, 2026

View reviewed changes

diquoks added 3 commits January 18, 2026 12:23

Adjust test to show visual changes more noticeable

218f113

Add vertical letterboxes

93e773b

Move division to other place

0526095

diquoks requested a review from peppy January 18, 2026 09:45

diquoks commented Jan 18, 2026

View reviewed changes

Fix tests again

88007a0

		fillMode = config.GetBindable<BackgroundFillMode>(OsuSetting.BackgroundFillMode);
		fillMode.BindValueChanged(_ => loadBeatmapBackground(beatmap));

Uh oh!

Conversation

diquoks commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nagi-desuuu commented Dec 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peppy commented Dec 29, 2025

Uh oh!

diquoks commented Dec 29, 2025

Uh oh!

peppy commented Dec 29, 2025

Uh oh!

bdach commented Dec 29, 2025

Uh oh!

peppy commented Dec 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peppy commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

diquoks commented Jan 13, 2026

Uh oh!

peppy commented Jan 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

diquoks commented Dec 22, 2025 •

edited

Loading

peppy commented Jan 13, 2026 •

edited

Loading