NEW: MouseEvents for InputSystem - Sending data from package & Samples and Tests #2207

ritamerkl · 2025-07-24T20:10:48Z

Description

This PR introduces sending pointer data (e.g. mouse, pen, touch...) to native for the OnMouse events driven by the InputSystem. It also adds tests and samples for the OnMouse events working with the InputSystem. The behaviour on native side is introduced with this PR and both PR's should land together, or one (shortly) after the other.

Testing status & QA

Only manual testing for the sample.

Overall Product Risks

Complexity: 1
Halo Effect: 1

Comments to reviewers

Please review together with https://github.cds.internal.unity3d.com/unity/unity/pull/73198.

Checklist

Before review:

Changelog entry added.
- Explains the change in Changed, Fixed, Added sections.
- For API change contains an example snippet and/or migration example.
- JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
- Jira port for the next release set as "Resolved".
Tests added/changed, if applicable.
- Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
- Performance tests.
- Integration tests.
Docs for new/changed API's.
- Xmldoc cross references are set correctly.
- Added explanation how the API works.
- Usage code examples added.
- The manual is updated, if needed.

During merge:

Commit message for squash-merge is prefixed with one of the list:
- NEW: ___.
- FIX: ___.
- DOCS: ___.
- CHANGE: ___.
- RELEASE: 1.1.0-preview.3.

After merge:

Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

codecov-github-com · 2025-07-24T22:43:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff             @@
##           develop    #2207      +/-   ##
===========================================
- Coverage    68.15%   68.15%   -0.01%     
===========================================
  Files          367      367              
  Lines        53662    53586      -76     
===========================================
- Hits         36576    36521      -55     
+ Misses       17086    17065      -21

Flag	Coverage Δ
linux_2021.3_pkg	`?`
linux_2022.3_pkg	`?`
linux_6000.0_pkg	`?`
linux_6000.1_pkg	`?`
linux_6000.2_pkg	`?`
linux_6000.2_project	`?`
linux_trunk_pkg	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
.../com.unity.inputsystem/InputSystem/InputManager.cs	`88.69% <ø> (-0.09%)`	⬇️

... and 19 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

jfreire-unity

Nice work @ritamerkl ! I like the approach and the sample is of reasonable size to test the main functionality. Also really nice to have plenty of tests.

However:

This functionality needs to be guarded with defines in asmdef, as this will only be available from 6.3 forward AFAIK. So if I try this PR without the trunk PR, I'll get compilation errors.
I would like to see at least 1 test with Touch as well, particularly with more than 1 touch. Mouse and Pen are pretty similar as they are a single pointer.

Assets/Tests/InputSystem/CoreTests_MouseEvents.cs

Packages/com.unity.inputsystem/CHANGELOG.md

Assets/Samples/MouseEvents/OnMouseEventsTest.cs

jfreire-unity · 2025-07-25T08:01:52Z

Nice work @ritamerkl ! I like the approach and the sample is of reasonable size to test the main functionality. Also really nice to have plenty of tests.

However:

This functionality needs to be guarded with defines in asmdef, as this will only be available from 6.3 forward AFAIK. So if I try this PR without the trunk PR, I'll get compilation errors.

I would like to see at least 1 test with Touch as well, particularly with more than 1 touch. Mouse and Pen are pretty similar as they are a single pointer.

Also there's some CI failures that will need to be addressed. Not sure if it's only because of the lack of defines or if there's any impact on pointer devices functionality.

ritamerkl · 2025-07-25T08:54:33Z

WIP: working on adding touch samples (multi-touch) & parallel pointers (eg. touch&pen).

LeoUnity

This is looking great!
I'm happy to see us improving our feature parity! Also thanks for investing the time on the tests!
I've left a few comments, but I'll leave it up to you to decide which ones to address

LeoUnity · 2025-07-28T14:33:15Z

Assets/Samples/MouseEvents/OnMouseEventsTest.cs

+            x = Pointer.current.position.x.value;
+            y = Pointer.current.position.y.value;
+        }
+        else  // Fallback to InputManager if InputSystem is not available


Do we need to support InputManager on this tests? I would assume they are covered by their original tests in trunk...

I see no reason why this would use InputManager similar to Leo, I would additionally recommend to rename this script to OnMouseEvents, or MouseEvents or similar. The Test suffix got me thinking I was going to see a NUnit test file or similar

LeoUnity · 2025-07-28T14:35:57Z

Assets/Tests/InputSystem/CoreTests_MouseEvents.cs

+    [Category("MouseEvents")]
+    public IEnumerator PenEvents_CanReceiveOnMouseDown()
+    {
+        var pen = InputSystem.AddDevice<Pen>();


It seems like we are duplicating the exact same tests for both mouse and pen, I'm wondering if we can parameterize that and just have a single test...

Agree to previous comment, this isn't necessarily the case any longer either right? "That we have to queue into NativeInputRuntime"?

LeoUnity · 2025-07-28T14:48:44Z

untitled folder/Il2CppOutputProject/Source/il2cppOutput/il2cpp-compile.traceevents

@@ -0,0 +1,4215 @@
+{ "pid": 11157, "tid": -1, "ph": "M", "name": "process_name", "args": { "name": "il2cpp-compile" } },


I'm guessing the untitled folder doesn't need to be included?

ekcoh

I see 3 files under "untitled folder", the folder including those files should be removed from this PR right?

ekcoh · 2025-08-22T13:26:53Z

Packages/com.unity.inputsystem/InputSystem/InputManager.cs

@@ -3646,6 +3647,9 @@ private unsafe void OnUpdate(InputUpdateType updateType, ref InputEventBuffer ev
            ////       mess in the event buffer
            ////       same goes for events that someone may queue from a change monitor callback
            InvokeAfterUpdateCallback(updateType);
+            //send pointer data to backend for OnMouseEvents
+            if (Pointer.current != null && gameIsPlaying)


@ritamerkl Have you checked if Input Manager supports OnMouseXXX events from a script that is marked with [ExecuteInEditorMode]? That could be relevant here...

ekcoh · 2025-08-22T13:28:07Z

Packages/com.unity.inputsystem/InputSystem/InputManager.cs

@@ -3646,6 +3647,9 @@ private unsafe void OnUpdate(InputUpdateType updateType, ref InputEventBuffer ev
            ////       mess in the event buffer
            ////       same goes for events that someone may queue from a change monitor callback
            InvokeAfterUpdateCallback(updateType);
+            //send pointer data to backend for OnMouseEvents
+            if (Pointer.current != null && gameIsPlaying)
+                NativeInputSystem.SetMouseEventsData(Pointer.current.press.isPressed, Pointer.current.press.wasPressedThisFrame, Pointer.current.position.x.value, Pointer.current.position.y.value);


Shouldn't this be routed via INativeInputRuntime interface and its NativeInputRuntime and TestInputRuntime implementations?

ritamerkl added 4 commits July 17, 2025 17:30

added a very basic mouse events sample

857e304

added MouseEventScript

3cc804f

added mouse events test for pen and mouse

dcf359a

add changelog

b1cf800

ritamerkl requested review from Pauliusd01, LeoUnity and jfreire-unity July 24, 2025 20:11

jfreire-unity requested changes Jul 25, 2025

View reviewed changes

jfreire-unity reviewed Jul 25, 2025

View reviewed changes

Assets/Tests/InputSystem/CoreTests_MouseEvents.cs Outdated Show resolved Hide resolved

Packages/com.unity.inputsystem/CHANGELOG.md Outdated Show resolved Hide resolved

Assets/Samples/MouseEvents/OnMouseEventsTest.cs Outdated Show resolved Hide resolved

ritamerkl added 2 commits July 25, 2025 10:47

added defines and outsourced code duplication

b0201e1

mention editor version in changelog

bab6e35

ritamerkl and others added 4 commits July 25, 2025 11:14

remove enhanced touch enable

c3e5dc3

Merge branch 'develop' into mouseevents-samles-tests

8f2c237

added touch test

167eb0f

added more touch tests

ff22909

LeoUnity approved these changes Jul 29, 2025

View reviewed changes

added sending pointer data to native for OnMouse events

18b1cc8

ritamerkl changed the title ~~NEW: MouseEvents for InputSystem Samples & Tests~~ NEW: MouseEvents for InputSystem - Sending data from package & Samples and Tests Aug 22, 2025

ekcoh requested changes Aug 22, 2025

View reviewed changes

ekcoh reviewed Aug 22, 2025

View reviewed changes

Merge branch 'develop' into mouseevents-samles-tests

042bc00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

NEW: MouseEvents for InputSystem - Sending data from package & Samples and Tests #2207

NEW: MouseEvents for InputSystem - Sending data from package & Samples and Tests #2207

Uh oh!

ritamerkl commented Jul 24, 2025 •

edited

Loading

Uh oh!

codecov-github-com bot commented Jul 24, 2025 •

edited

Loading

Uh oh!

jfreire-unity left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jfreire-unity commented Jul 25, 2025

Uh oh!

ritamerkl commented Jul 25, 2025 •

edited

Loading

Uh oh!

LeoUnity left a comment

Uh oh!

LeoUnity Jul 28, 2025

Uh oh!

ekcoh Aug 22, 2025

Uh oh!

LeoUnity Jul 28, 2025

Uh oh!

ekcoh Aug 22, 2025

Uh oh!

LeoUnity Jul 28, 2025

Uh oh!

ekcoh left a comment

Uh oh!

ekcoh Aug 22, 2025

Uh oh!

ekcoh Aug 22, 2025

Uh oh!

Uh oh!

		@@ -0,0 +1,4215 @@
		{ "pid": 11157, "tid": -1, "ph": "M", "name": "process_name", "args": { "name": "il2cpp-compile" } },

NEW: MouseEvents for InputSystem - Sending data from package & Samples and Tests #2207

Are you sure you want to change the base?

NEW: MouseEvents for InputSystem - Sending data from package & Samples and Tests #2207

Uh oh!

Conversation

ritamerkl commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing status & QA

Overall Product Risks

Comments to reviewers

Checklist

Uh oh!

codecov-github-com bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jfreire-unity left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jfreire-unity commented Jul 25, 2025

Uh oh!

ritamerkl commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LeoUnity left a comment

Choose a reason for hiding this comment

Uh oh!

LeoUnity Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

ekcoh Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

LeoUnity Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

ekcoh Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

LeoUnity Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

ekcoh left a comment

Choose a reason for hiding this comment

Uh oh!

ekcoh Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

ekcoh Aug 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ritamerkl commented Jul 24, 2025 •

edited

Loading

codecov-github-com bot commented Jul 24, 2025 •

edited

Loading

ritamerkl commented Jul 25, 2025 •

edited

Loading