Android Stylus pressure and tilt support. #80644

Distantz · 2023-08-14T23:58:31Z

Modified the Android input code to send pressure and tilt information.

Bugsquad edit:

Implement Android part of Add iOS Android pen pressure / tilt support godot-proposals#735

Distantz · 2023-08-14T23:59:28Z

Have verified that this works on my Galaxy Tab S7.

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

akien-mga · 2023-08-15T07:10:46Z

Thanks for the contribution! Did you check if this solves any existing bug report or feature proposal?

Please make changes to the PR by amending the commit and force pushing the branch, so style fixes for example become part of the main commit, instead of follow up fixup commits. See PR workflow for details.

Distantz · 2023-08-15T07:41:24Z

I believe it satisfies the Android half of godotengine/godot-proposals#735.

akien-mga · 2023-08-15T07:44:01Z

I believe it satisfies the Android half of godotengine/godot-proposals#735.

Thanks! Please also have a look at #49609 for comparison - it looks like your PR is more feature complete as it also implements tilt and not just pressure. The discussion in the PR might still be useful to make this one fully ready to merge.

CC @ModProg @HEAVYPOLY

Distantz · 2023-08-15T08:12:31Z

Had a look at #49609, seem's like they had a couple of issues with getting the stylus to register up and down events. From what I can see testing right now, my PR does emit these events.

Distantz · 2023-08-15T08:19:50Z

Logcat output from my tablet for a stylus press, move and release.

akien-mga · 2023-08-15T09:07:11Z

Have verified that this works on my Galaxy Tab S7.

Did some testing to get another data point, before remembering that my device is also a Galaxy Tab S7 :P

Anyway, I can confirm it seems to work well on that device, with a generic stylus I got with it.

Screenshot of received events while writing my name with the stylus.

Distantz · 2023-08-15T09:13:33Z

Good to know its not a fluke haha

akien-mga

Tested functionality, works fine for a basic test (didn't try it on a real app that would make use of pressure and tilt). Code style looks good.

I'll let @godotengine/android review the actual implementation for Android.

Calinou · 2023-08-15T10:28:47Z

Do we have a testing project that features pen drawing somewhere? (If not, this could be worth adding to godot-demo-projects.)

Distantz · 2023-08-15T10:41:25Z

I've got a project I've been using to test this that displays the pressure (in both text and colour background) alongside the tilt, can post that here if needed.

Calinou · 2023-08-15T10:48:09Z

I've got a project I've been using to test this that displays the pressure (in both text and colour background) alongside the tilt, can post that here if needed.

Please upload it here 🙂

Distantz · 2023-08-15T10:58:23Z

PressureTest.zip

Here you are. Hopefully it isn't too sloppy code-wise.

ModProg · 2023-08-15T11:13:08Z

I'll probably not be able to experiment with this before the beginning of September, unless someone builds the APK for me 😬.

My devicd would be a Note 10 lite, i.e. a smart phone.

Distantz · 2023-08-15T11:40:57Z

@ModProg I am able to give you the APK, but GitHub only allows max 25mb as attachments. Any way to send it to you?

Zireael07 · 2023-08-15T12:02:11Z

Won't a zipped apk fit under the limit?

Distantz · 2023-08-15T12:07:22Z

Mine is 37mb at max compression (for reference, the raw APK is 40mb), although there might be a way to shrink it in Godot that I don't know about?

Calinou · 2023-08-15T12:16:13Z

Mine is 37mb at max compression (for reference, the raw APK is 40mb), although there might be a way to shrink it in Godot that I don't know about?

It can be shrunk by only including a single architecture. arm64 nowadays is ubiquitous on phones and tablets, with x86_64 only being relevant for Chromebooks and emulators on PC. Some low-end phones/tablets in use today are still armv7, but their count is only decreasing as time goes on.

Here's the release export template APK I built from this PR (arm64 only): android_release.apk.zip

Exported project APK: Android Pressure Test.apk.zip

Distantz · 2023-08-15T12:22:55Z

Legendary, @ModProg this is for you 👍

Calinou · 2023-08-15T12:25:55Z

I've tested the project locally. Both pressure and tilt reporting work as expected (Samsung Galaxy Z Fold4, Android 13, S Pen Fold Edition).

Note that if the pen appears to do nothing, make sure it's enabled in the system settings.

ModProg · 2023-08-15T12:37:08Z

I think I ran into a similar problem I had when implementing this IIRC.

There is only an output when I start moving, simply pressing down doesn't do anything independent from how hard I press down.

Screen_Recording_20230815_193156_Android.Pressure.Test.mp4

ModProg · 2023-08-15T12:38:20Z

Slow movements also don't trigger it. Thou I haven't looked at the Testprojekt, might be it is written to behave this way?

Distantz · 2023-08-15T13:15:18Z

Only InputEventMouseMotion has a pressure field, so the InputEventMouseButton events don't have any pressure information. I think there must be some sort of threshold (for displacement from the beginning position) built-in for triggering the motion events. The test project I supplied only displays motion events

ModProg · 2023-08-15T16:06:51Z

One thing I noticed in my testing, was that pen touching without moving wasn't detected at all, because Samsung introduced custom actions: ModProg@cbce6a1

Edit: This could also have been related to the eraser thinking about it now.

2 years is a long time and I'm not 100% sure, but would be good if we supported the action button an s-pen has on the side as well.

Distantz · 2023-08-15T20:58:14Z

I think supporting the stylus buttons is a different issue and should probably be in its own PR. If we do support the Samsung codes, could that potentially cause issues relating to duplicate events?

ModProg · 2023-08-16T03:17:10Z

I think supporting the stylus buttons is a different issue and should probably be in its own PR. If we do support the Samsung codes, could that potentially cause issues relating to duplicate events?

IIRC they just didn't send the nornal codes. But it would also be interesting whether e.g. Huawei sends the same or different codes. I don't think I ever researched that.

ModProg · 2023-08-16T03:50:29Z

But I agree, this is not necessarily a blocker for this PR. When I hopefully continue the project I wanted pen support for, I'll revisit this and can add those then.

Distantz · 2023-08-16T10:38:16Z

I see, thank you for the clarification!

m4gr3d · 2023-08-17T23:36:39Z

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java

@@ -433,7 +433,7 @@ static boolean isMouseEvent(MotionEvent event) {
 	}

 	private static boolean isMouseEvent(int eventSource) {
-		boolean mouseSource = ((eventSource & InputDevice.SOURCE_MOUSE) == InputDevice.SOURCE_MOUSE) || ((eventSource & (InputDevice.SOURCE_TOUCHSCREEN | InputDevice.SOURCE_STYLUS)) == InputDevice.SOURCE_STYLUS);


What's the reason for removing the SOURCE_TOUCHSCREEN check?

I couldn't get it to work without removing that. I think SOURCE_TOUCHSCREEN is used for fingers also?

Should we try it like this, or investigate further?

From what I can test, there seems to be no regression in touch handling when removing that SOURCE_TOUCHSCREEN, I think it should be fine to try it like this.

It looks like this change has introduced the following regression: #88621

m4gr3d · 2023-08-17T23:46:57Z

Asides from the comment above the logic looks good!

Only InputEventMouseMotion has a pressure field, so the InputEventMouseButton events don't have any pressure information.

InputEventMouseMotion extends from InputEventMouseButton, so it's worth considering whether we should move the tilt and pressure fields into InputEventMouseButton instead.

@Distantz Thoughts?

Distantz · 2023-08-18T06:12:16Z

I think that could definitely be a good change, but I think it would require some conversation with the other platforms. For Android specifically, it should be easy to implement.

akien-mga · 2023-08-28T11:06:26Z

Asides from the comment above the logic looks good!

Only InputEventMouseMotion has a pressure field, so the InputEventMouseButton events don't have any pressure information.

InputEventMouseMotion extends from InputEventMouseButton, so it's worth considering whether we should move the tilt and pressure fields into InputEventMouseButton instead.

To be clear, the inheritance tree is like this:

InputEventMouse
- InputEventMouseButton
- InputEventMouseMotion

So indeed the tilt and pressure properties could be made available to both Button and Motion events if moved to the base InputEventMouse.

This is IMO outside the scope of this PR though, and we'd need to evaluate whether moving properties to a parent class like this will break API or ABI compatibility.

akien-mga · 2023-09-17T12:36:48Z

Let's proceed and merge, if @m4gr3d still has concerns on the change to isMouseEvent, we can improve it later on.

akien-mga · 2023-09-17T12:49:37Z

Thanks! And congrats for your first merged Godot contribution 🎉

Distantz requested a review from a team as a code owner August 14, 2023 23:58

akien-mga reviewed Aug 15, 2023

View reviewed changes

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java Outdated Show resolved Hide resolved

akien-mga reviewed Aug 15, 2023

View reviewed changes

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java Outdated Show resolved Hide resolved

akien-mga reviewed Aug 15, 2023

View reviewed changes

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java Outdated Show resolved Hide resolved

akien-mga reviewed Aug 15, 2023

View reviewed changes

platform/android/java/lib/src/org/godotengine/godot/input/GodotInputHandler.java Outdated Show resolved Hide resolved

akien-mga added feature proposal platform:android topic:porting topic:input labels Aug 15, 2023

akien-mga added this to the 4.x milestone Aug 15, 2023

akien-mga requested a review from a team August 15, 2023 07:09

Distantz force-pushed the master branch from 7fb4692 to 6404c10 Compare August 15, 2023 07:48

Android stylus pressure and tilt support

7494ad6

Distantz force-pushed the master branch from 6404c10 to 7494ad6 Compare August 15, 2023 07:55

akien-mga approved these changes Aug 15, 2023

View reviewed changes

Calinou mentioned this pull request Aug 15, 2023

[android] Added pressure support for stylus. #49609

Closed

Calinou approved these changes Aug 15, 2023

View reviewed changes

akien-mga requested a review from a team August 17, 2023 10:08

akien-mga modified the milestones: 4.x, 4.2 Aug 17, 2023

m4gr3d reviewed Aug 17, 2023

View reviewed changes

akien-mga requested a review from m4gr3d September 4, 2023 07:09

akien-mga merged commit 4b2fb36 into godotengine:master Sep 17, 2023
15 checks passed

akien-mga mentioned this pull request Sep 17, 2023

Add iOS Android pen pressure / tilt support godotengine/godot-proposals#735

Closed

Sauermann mentioned this pull request Apr 27, 2024

Touch events not working on Godot 4.2+ on Android 14 after PR #80644 #88621

Open

Android Stylus pressure and tilt support. #80644

Android Stylus pressure and tilt support. #80644

Conversation

Distantz commented Aug 14, 2023 • edited by akien-mga

Distantz commented Aug 14, 2023 • edited

akien-mga commented Aug 15, 2023

Distantz commented Aug 15, 2023

akien-mga commented Aug 15, 2023 • edited

Distantz commented Aug 15, 2023

Distantz commented Aug 15, 2023

akien-mga commented Aug 15, 2023

Distantz commented Aug 15, 2023

akien-mga left a comment

Choose a reason for hiding this comment

Calinou commented Aug 15, 2023 • edited

Distantz commented Aug 15, 2023

Calinou commented Aug 15, 2023

Distantz commented Aug 15, 2023

ModProg commented Aug 15, 2023 • edited

Distantz commented Aug 15, 2023

Zireael07 commented Aug 15, 2023

Distantz commented Aug 15, 2023 • edited

Calinou commented Aug 15, 2023 • edited

Distantz commented Aug 15, 2023

Calinou commented Aug 15, 2023 • edited

ModProg commented Aug 15, 2023

ModProg commented Aug 15, 2023

Distantz commented Aug 15, 2023 • edited

ModProg commented Aug 15, 2023 • edited

Distantz commented Aug 15, 2023

ModProg commented Aug 16, 2023

ModProg commented Aug 16, 2023

Distantz commented Aug 16, 2023

m4gr3d Aug 17, 2023

Choose a reason for hiding this comment

Distantz Aug 18, 2023

Choose a reason for hiding this comment

akien-mga Aug 28, 2023

Choose a reason for hiding this comment

Distantz Sep 3, 2023

Choose a reason for hiding this comment

Sauermann Apr 28, 2024

Choose a reason for hiding this comment

m4gr3d commented Aug 17, 2023

Distantz commented Aug 18, 2023

akien-mga commented Aug 28, 2023

akien-mga commented Sep 17, 2023

akien-mga commented Sep 17, 2023

Distantz commented Aug 14, 2023 •

edited by akien-mga

Distantz commented Aug 14, 2023 •

edited

akien-mga commented Aug 15, 2023 •

edited

Calinou commented Aug 15, 2023 •

edited

ModProg commented Aug 15, 2023 •

edited

Distantz commented Aug 15, 2023 •

edited

Calinou commented Aug 15, 2023 •

edited

Calinou commented Aug 15, 2023 •

edited

Distantz commented Aug 15, 2023 •

edited

ModProg commented Aug 15, 2023 •

edited