Expose tablet OutputSize #6460

DanielPower · 2024-12-16T04:54:39Z

Resolves #6150
Related to ppy/osu#12098
Required by ppy/osu#31141

Description

Exposes new bindables OutputAreaSize and OutputAreaOffset, so that absoluteOutputMode.Output can be updated from osu.Game.

Includes new testing sliders for output area and rotation. Updated input area visualization to show rotation, and added a new visualization for output area.

bdach · 2024-12-16T05:13:50Z

osu.Framework/Input/Handlers/Tablet/OpenTabletDriverHandler.cs

@@ -38,6 +38,8 @@ public class OpenTabletDriverHandler : InputHandler, IAbsolutePointer, IRelative

        public Bindable<Vector2> AreaSize { get; } = new Bindable<Vector2>();

+        public Bindable<Vector2> OutputSize { get; } = new Bindable<Vector2>();


Not sold on this API design. I'd say this should be nullable, and if the output size is null, then it is presumed that the output area is the whole window (which would fall back to the old logic). Curious of other thoughts on this though @ppy/team-client

OutputAreaSize now has a default value of Vector2(1f, 1f). So it behaves correctly on first launch.
OutputAreaPosition does not have a default value, but it's unused until the scaling mode is changed, at which point it will have been populated. I could give it a default of Vector2(0.5f, 0.5f) if that would be preferable.

I'm also open to making them nullable if that would be better.

Looking at things in their current state, I think I'm fine with the proposed API? Better than nullable values IMHO.

hwsmm · 2024-12-16T05:30:19Z

Seems like a duplicate of #6166?

DanielPower · 2024-12-16T05:36:47Z

Seems like a duplicate of #6166?

That's a good catch. I can close this and instead use #6166 as a base for ppy/osu#31141 if that would be preferable. Their PR is more complete as it also includes the output position, which may be useful for future configurability.

…een-scaling-tablet-output # Conflicts: # osu.Framework/Input/Handlers/Tablet/ITabletHandler.cs # osu.Framework/Input/Handlers/Tablet/OpenTabletDriverHandler.cs

… screen-scaling-tablet-output # Conflicts: # osu.Framework/Input/Handlers/Tablet/ITabletHandler.cs

DanielPower · 2024-12-17T01:05:44Z

#6166 is too outdated to work off of directly due to conflicts with osu.Game. So I've:

merged @Feodor0090's changes into this branch
updated Scale tablet output size when UI Scaling mode is "Everything" osu#31141 accordingly
Updated some wording and simplified logic

Apologies, this has made the commit history a little messy. I can rebase if desired, but I'll leave it as-is for now since CONTRIBUTING.md discourages rebasing.

bdach · 2024-12-26T11:16:20Z

osu.Framework/Input/Handlers/Tablet/OpenTabletDriverHandler.cs

-            else
-                tablet.Value = null;


what is this change? this removal does not look correct in this context

Apologies, I missed this when merging in #6166, which resulted in some conflicts due to being outdated. I've now addressed this.

bdach · 2024-12-26T11:19:19Z

aside from the above this looks roughly correct, but was there even any testing done here? no changes to test scenes to even add sliders to play with this framework side or anything, so i question whether this was tested to work at all.

peppy · 2024-12-26T11:43:35Z

I assumed cross-testing with ppy/osu#31141, which looks to be working well for at least the user. I haven't personally tested, if we can have some minimal framework tests that definitely would be appreciated.

DanielPower · 2024-12-31T01:10:53Z

but was there even any testing done here?

I've cross-tested with ppy/osu#31141 and included a video in that PR demonstrating the new behaviour. I included a note in that PR asking for advice on how to do testing (since automated testing would require a way to mock tablet input). But I should have included that note on this PR as well.

I'll look into adding some sliders to the test framework, so that it can be tested manually.

Edit: Adding sliders to osu-framework's visual testing was a great callout. The behaviour isn't quite what I was expecting on the framework side, and I was compensating for it on the osu-game side. I'll temporarily draft this PR, and will aim to work out a better solution shortly after New Years.

…ling-tablet-output # Conflicts: # osu.Framework.Tests/Visual/Input/TestSceneTabletInput.cs

DanielPower · 2025-06-18T23:22:07Z

osu.Framework.Tests/Visual/Input/TestSceneTabletInput.cs

+                    y => tabletHandler.OutputAreaOffset.Value = new Vector2(
+                        tabletHandler.OutputAreaOffset.Value.X, y));
+
+                AddSliderStep("change rotation", 0, 360, 0f,


This is out of scope, but I needed to test that my changes wouldn't break with rotation. I could break this into a separate PR if you'd like, but I figure it's a simple enough addition to include here.

DanielPower · 2025-06-18T23:43:17Z

Sorry it's taken so long to get back to this. It's much later than the "Shortly after New Years" that I promised 😅

Changes since the last review include:

Added testing sliders for output area size, output area offset, and rotation.
Addressed positioning bugs from the previous implementation.
Removed the unnecessary call to updateOutputArea.
Added default values for OutputAreaSize and OutputAreaOffset.
Merged in the latest master branch, since there were conflicts.

On the note of the default values, I found that when restarting the test framework, if there are no sliders for the values, the last used values will be used instead of the default values. I'm assuming there's a config file somewhere storing these values that I should be clearing when testing. I'm currently trying to figure out where that is, so I can validate that the default values will work correctly on a fresh or existing installation.

One thing this PR hasn't changed is the tablet area visualization. Output area and rotation are not reflected in the visualization.

Edit: I've now included a tablet area visualization for output area.

DanielPower · 2025-06-19T00:10:54Z

As a bit of a tangent, I implemented OutputAreaOffset so that the output area remains within the bounds of the screen. (0, 0) is aligned to the top-left, and (1, 1) is aligned to the bottom-right. This is different from the existing input area implementation, where you position the center of the area directly, allowing the input area to be partially outside the tablet.

I think it would make sense to adjust the input area to fix this behaviour. But it would cause differences for anyone who has changed their offset unless we could migrate saved config values. It's outside the scope of this PR, but figured I'd mention it.

DanielPower · 2025-06-20T03:12:49Z

osu.Framework.Tests/Visual/Input/TestSceneTabletInput.cs

@@ -40,7 +41,8 @@ public TestSceneTabletInput()
                Children = new Drawable[]
                {
                    tabletInfo = new SpriteText(),
-                    areaVisualizer = new TabletAreaVisualiser(),
+                    inputAreaVisualizer = new TabletAreaVisualiser(Vector2.One, "Input area", false),
+                    outputAreaVisualizer = new TabletAreaVisualiser(new Vector2(256, 144), "Output area", true),


256x144 is just an arbitrary 16:9 scale size for visualization purposes.

DanielPower · 2025-06-20T03:15:42Z

osu.Framework.Tests/Visual/Input/TestSceneTabletInput.cs

-                }, true);
-                AreaSize.DefaultChanged += fullSize => fullArea.Size = fullSize.NewValue;
-                fullArea.Size = AreaSize.Default;
+                AreaSize.DefaultChanged += _ => updateVisualiser();


When the area is confined, position depends on size. Moving all calculations to a single function was simpler.

Feodor0090 and others added 5 commits February 2, 2024 02:14

Add output area and size to OTD handler

7bac31e

Expose area properties via ITabletHandler

56db884

Add better explanation how OutputAreaPosition works

abc34ab

Remove mention about osu!'s component

f8aab30

Initial proof of concept for tablet output scaling

eee564b

pull-request-size bot added the size/S label Dec 16, 2024

DanielPower changed the title ~~Initial proof of concept for tablet output scaling~~ Allow modifying Tablet Output Area Dec 16, 2024

DanielPower mentioned this pull request Dec 16, 2024

Scale tablet output size when UI Scaling mode is "Everything" ppy/osu#31141

Draft

DanielPower changed the title ~~Allow modifying Tablet Output Area~~ Expose tablet OutputSize Dec 16, 2024

Remove console log

9820c11

bdach reviewed Dec 16, 2024

View reviewed changes

Merge remote-tracking branch 'feodor0090/tablet-output-area' into scr…

082e586

…een-scaling-tablet-output # Conflicts: # osu.Framework/Input/Handlers/Tablet/ITabletHandler.cs # osu.Framework/Input/Handlers/Tablet/OpenTabletDriverHandler.cs

pull-request-size bot added size/M and removed size/S labels Dec 17, 2024

DanielPower added 7 commits December 16, 2024 20:32

Merge remote-tracking branch 'feodor0090/tablet-output-area' into scr…

9ced124

…een-scaling-tablet-output # Conflicts: # osu.Framework/Input/Handlers/Tablet/ITabletHandler.cs # osu.Framework/Input/Handlers/Tablet/OpenTabletDriverHandler.cs

Merge remote-tracking branch 'fork/screen-scaling-tablet-output' into…

a547cc4

… screen-scaling-tablet-output # Conflicts: # osu.Framework/Input/Handlers/Tablet/ITabletHandler.cs

Fix unintended changes from merging old branch

782d505

Undo unintended change

59c2b5f

Update wording for OutputAreaPosition summary

93ca8c0

Remove trivial comments

93b2feb

Simplify scaling/positioning logic

1f3075e

DanielPower marked this pull request as ready for review December 17, 2024 01:06

DanielPower requested a review from bdach December 17, 2024 01:09

DanielPower marked this pull request as draft December 17, 2024 01:11

DanielPower added 2 commits December 16, 2024 21:45

Address ambiguous arithmetic precedence

679c19f

Address ambiguous arithmetic precedence

a059213

DanielPower marked this pull request as ready for review December 17, 2024 01:23

Minor cleanup

6cc3d7f

peppy previously approved these changes Dec 24, 2024

View reviewed changes

bdach requested changes Dec 26, 2024

View reviewed changes

Address conflict

51a1f6b

DanielPower dismissed peppy’s stale review via 51a1f6b December 31, 2024 01:07

DanielPower marked this pull request as draft December 31, 2024 01:41

DanielPower added 3 commits June 18, 2025 19:39

Fix test UI for tablet output area

bd9c868

Merge branch 'master' of github.com:ppy/osu-framework into screen-sca…

a114be7

…ling-tablet-output # Conflicts: # osu.Framework.Tests/Visual/Input/TestSceneTabletInput.cs

Fix output area position and add testing sliders

7dad0c9

DanielPower commented Jun 18, 2025

View reviewed changes

DanielPower added 2 commits June 18, 2025 20:53

Remove unnecessary updateOutputArea call

ffa4024

Restore default values

1c8338a

DanielPower requested review from peppy and bdach June 18, 2025 23:43

DanielPower marked this pull request as ready for review June 18, 2025 23:43

Add visualizer for output area

d35404e

pull-request-size bot added size/L and removed size/M labels Jun 20, 2025

DanielPower commented Jun 20, 2025

View reviewed changes

Display tablet rotation in visualiser

6babe4d

		@@ -38,6 +38,8 @@ public class OpenTabletDriverHandler : InputHandler, IAbsolutePointer, IRelative

		public Bindable<Vector2> AreaSize { get; } = new Bindable<Vector2>();

		public Bindable<Vector2> OutputSize { get; } = new Bindable<Vector2>();

Expose tablet OutputSize #6460

Are you sure you want to change the base?

Expose tablet OutputSize #6460

Uh oh!

Conversation

DanielPower commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

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!

hwsmm commented Dec 16, 2024

Uh oh!

DanielPower commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DanielPower commented Dec 17, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bdach commented Dec 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

peppy commented Dec 26, 2024

Uh oh!

DanielPower commented Dec 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielPower commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DanielPower commented Jun 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DanielPower commented Dec 16, 2024 •

edited

Loading

DanielPower commented Dec 16, 2024 •

edited

Loading

bdach commented Dec 26, 2024 •

edited

Loading

DanielPower commented Dec 31, 2024 •

edited

Loading

DanielPower commented Jun 18, 2025 •

edited

Loading

DanielPower commented Jun 19, 2025 •

edited

Loading