FIX: ISXB-687 Added guard clause to RemovePointerAtIndex in InputSy… #1982

adrian-koretski-unity3d · 2024-08-13T17:37:24Z

Description

When we disable a behaviour, the touch pointer no longer gets removed twice.

Changes made

Added code to prevent the first removal of the touch pointer (since we want to defer it to the following frame).

Testing

Manual testing

Risk

Low risk

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.

…emUIInputModule to not remove touch pointers on the same frame they are released.

unity-cla-assistant · 2024-08-13T17:37:30Z

All committers have signed the CLA.

ekcoh · 2024-08-14T10:44:51Z

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

@@ -1897,6 +1897,13 @@ private void RemovePointerAtIndex(int index)
        {
            Debug.Assert(m_PointerStates[index].eventData.pointerEnter == null, "Pointer should have exited all objects before being removed");

+            // We don't want to release touch pointers on the same frame they are released. They get cleaned up one frame later in Process() 


The reasoning in the comment makes sense to me, however I wonder why the below conditions are needed, it sounds like it would be more of a general fix that pointers (that may only exist during contact) shouldn't be removed mid frame for any scenario?

I looked through the file but failed to spot where the clean-up/removal happens when this condition triggers, do you have a reference?

Yes, the cleanup I'm referring to happens on line 2222 in the same file (InputSystemUIInputModule) in the Process() function call.

ekcoh

Seems like this test UITests.UI_CanDriveUIFromMultiplePointers(SingleMouseOrPenButMultiTouchAndTrack) is not passing? Needs to be fixed to get green CI on this one, or first rerun to see it was not something wrong with the environment.

ekcoh · 2024-09-05T09:47:54Z

@adrian-koretski-unity3d Seems like it needs resolved conflict and CI rerun to get into green state before QA pass

ekcoh

Seems like failing tests and conflicts needs some work.

…orce their release on the same frame they occur. Ran the formatter and applied changes to CHANGELOG.md

Packages/com.unity.inputsystem/CHANGELOG.md

… inputs happen.

…/Unity-Technologies/InputSystem into isxb-543-fix-touch-double-remove

…certain pointers to be incorrectly released or not released.

Packages/com.unity.inputsystem/CHANGELOG.md

ekcoh

Need to remove hinge entry from CHANGELOG since its a duplicate

…System into isxb-543-fix-touch-double-remove # Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md

ekcoh

CHANGELOG still seems off?

Packages/com.unity.inputsystem/CHANGELOG.md

…/Unity-Technologies/InputSystem into isxb-543-fix-touch-double-remove

…System into isxb-543-fix-touch-double-remove

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

…nputSystemUIInputModule.

ekcoh

CHANGELOG.md looks good now, thank you @adrian-koretski-unity3d

Pauliusd01 · 2024-09-30T10:53:32Z

Will check this today

Pauliusd01

LGTM, tested the user project normally as well as rebinding the UI controls to something other than the mouse

adrian-koretski-unity3d added 2 commits August 12, 2024 10:41

FIX: ISXB-687 Added guard clause to RemovePointerAtIndex in InputSyst…

d280dff

…emUIInputModule to not remove touch pointers on the same frame they are released.

Added changelog entry for fix ISXB-543

8d3ca93

Merge branch 'develop' into isxb-543-fix-touch-double-remove

cb1bfb3

ekcoh reviewed Aug 14, 2024

View reviewed changes

ekcoh approved these changes Sep 5, 2024

View reviewed changes

ekcoh requested a review from Pauliusd01 September 5, 2024 09:48

ekcoh requested changes Sep 5, 2024

View reviewed changes

adrian-koretski-unity3d added 4 commits September 5, 2024 09:52

Merge branch 'develop' into isxb-543-fix-touch-double-remove

e600067

Merge branch 'develop' into isxb-543-fix-touch-double-remove

1cbfe3e

Fixed infinite loop caused by FilterPointerStatesByType() trying to f…

1f4e41c

…orce their release on the same frame they occur. Ran the formatter and applied changes to CHANGELOG.md

Merge branch 'develop' into isxb-543-fix-touch-double-remove

6715e26

AlexTyrer reviewed Sep 13, 2024

View reviewed changes

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

adrian-koretski-unity3d added 3 commits September 16, 2024 16:49

Fixed issue where touch pointers don't get released when mouse or pen…

84e2ca4

… inputs happen.

Merge branch 'isxb-543-fix-touch-double-remove' of https://github.com…

d952c79

…/Unity-Technologies/InputSystem into isxb-543-fix-touch-double-remove

Fixed incorrect boolean logic in InputSystemUIInputModule.cs causing …

22183df

…certain pointers to be incorrectly released or not released.

adrian-koretski-unity3d requested a review from ekcoh September 19, 2024 14:38

adrian-koretski-unity3d added 2 commits September 19, 2024 16:17

Moved changelog entry for ISXB-687 into unreleased.

11b8a0e

Merge branch 'develop' into isxb-543-fix-touch-double-remove

456f737

ekcoh approved these changes Sep 24, 2024

View reviewed changes

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

ekcoh requested changes Sep 24, 2024

View reviewed changes

adrian-koretski-unity3d added 2 commits September 24, 2024 13:58

Merge branch 'develop' of https://github.com/Unity-Technologies/Input…

43c0e80

…System into isxb-543-fix-touch-double-remove # Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md

Merge branch 'develop' into isxb-543-fix-touch-double-remove

c0d58cf

adrian-koretski-unity3d requested a review from ekcoh September 25, 2024 17:30

ekcoh requested changes Sep 27, 2024

View reviewed changes

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

adrian-koretski-unity3d added 4 commits September 27, 2024 09:16

Fixed duplicate entry in CHANGELOG

355499c

Merge branch 'isxb-543-fix-touch-double-remove' of https://github.com…

4671f6f

…/Unity-Technologies/InputSystem into isxb-543-fix-touch-double-remove

Merge branch 'develop' of https://github.com/Unity-Technologies/Input…

2eafdde

…System into isxb-543-fix-touch-double-remove

Moved double touch pointer changelog entry to unreleased.

efe6c3c

adrian-koretski-unity3d added 2 commits September 27, 2024 09:58

Removed additional duplicate entries in changelog

cd89b85

Merge branch 'develop' of https://github.com/Unity-Technologies/Input…

b40142f

…System into isxb-543-fix-touch-double-remove

AlexTyrer reviewed Sep 27, 2024

View reviewed changes

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs Outdated Show resolved Hide resolved

Removed superfluous code to get pointer state that is never used in I…

9699703

…nputSystemUIInputModule.

adrian-koretski-unity3d requested a review from ekcoh September 27, 2024 16:19

ekcoh approved these changes Sep 29, 2024

View reviewed changes

Pauliusd01 approved these changes Sep 30, 2024

View reviewed changes

adrian-koretski-unity3d added 2 commits October 1, 2024 10:26

Merge branch 'develop' into isxb-543-fix-touch-double-remove

667c1dc

Merge branch 'develop' into isxb-543-fix-touch-double-remove

bb5b327

adrian-koretski-unity3d merged commit ff7837e into develop Oct 2, 2024
77 checks passed

adrian-koretski-unity3d deleted the isxb-543-fix-touch-double-remove branch October 2, 2024 17:59

jfreire-unity added a commit that referenced this pull request Jul 7, 2025

Revert #1982 but leave commented code

550cf70

jfreire-unity added a commit that referenced this pull request Jul 11, 2025

Revert #1982 but leave commented code

355e947

jfreire-unity mentioned this pull request Jul 15, 2025

FIX: Pen touch input triggers UI/Click action two times (ISXB-1456) #2201

Merged

5 tasks

jfreire-unity added a commit that referenced this pull request Jul 25, 2025

Revert #1982 but leave commented code

194c58c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

FIX: ISXB-687 Added guard clause to RemovePointerAtIndex in InputSy… #1982

FIX: ISXB-687 Added guard clause to RemovePointerAtIndex in InputSy… #1982

Uh oh!

adrian-koretski-unity3d commented Aug 13, 2024 •

edited

Loading

Uh oh!

unity-cla-assistant commented Aug 13, 2024 •

edited

Loading

Uh oh!

ekcoh Aug 14, 2024

Uh oh!

adrian-koretski-unity3d Aug 14, 2024

Uh oh!

ekcoh Sep 5, 2024

Uh oh!

ekcoh left a comment •

edited

Loading

Uh oh!

ekcoh commented Sep 5, 2024

Uh oh!

ekcoh left a comment

Uh oh!

Uh oh!

Uh oh!

ekcoh left a comment

Uh oh!

ekcoh left a comment

Uh oh!

Uh oh!

Uh oh!

ekcoh left a comment

Uh oh!

Pauliusd01 commented Sep 30, 2024

Uh oh!

Pauliusd01 left a comment

Uh oh!

Uh oh!

Uh oh!

FIX: ISXB-687 Added guard clause to RemovePointerAtIndex in InputSy… #1982

FIX: ISXB-687 Added guard clause to RemovePointerAtIndex in InputSy… #1982

Uh oh!

Conversation

adrian-koretski-unity3d commented Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes made

Testing

Risk

Checklist

Uh oh!

unity-cla-assistant commented Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ekcoh Aug 14, 2024

Choose a reason for hiding this comment

Uh oh!

adrian-koretski-unity3d Aug 14, 2024

Choose a reason for hiding this comment

Uh oh!

ekcoh Sep 5, 2024

Choose a reason for hiding this comment

Uh oh!

ekcoh left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ekcoh commented Sep 5, 2024

Uh oh!

ekcoh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ekcoh left a comment

Choose a reason for hiding this comment

Uh oh!

ekcoh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ekcoh left a comment

Choose a reason for hiding this comment

Uh oh!

Pauliusd01 commented Sep 30, 2024

Uh oh!

Pauliusd01 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

adrian-koretski-unity3d commented Aug 13, 2024 •

edited

Loading

unity-cla-assistant commented Aug 13, 2024 •

edited

Loading

ekcoh left a comment •

edited

Loading