DOCS: Add information about IgnoreFocus to InputSettings.cs

[suearkinunity]

Description

From DOCATT-10243: information about BackgroundBehavior.IgnoreFocus

Testing status & QA

Docs only

Overall Product Risks

None

Comments to reviewers

Docs only

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.

[cla-assistant-unity]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ josepmariapujol-unity
❌ suearkinunity
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[u-pr]

PR Reviewer Guide 🔍

(Review updated until commit 0e5c3a5)

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ DOCATT-10243 - Fully compliant Compliant requirements: Clarify the IgnoreFocus behavior and its consequences. Explain that input controls may retain stale state. Advise users who need reliable state to use alternative reset modes. Add a section on background input limitations. Note specific behavior for Keyboard, Mouse, and XR HMDs. Clearly state that IgnoreFocus does not grant the ability to receive background input.

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪ This is a trivial PR to review as it consists solely of C# XML documentation comment additions with no underlying logic or functional changes.

🏅 Score: 100 The PR seamlessly translates all the documentation requirements outlined in the Jira ticket into clear, well-formatted XML comments in the exact appropriate locations.

🧪 No relevant tests

🔒 No security concerns identified

⚡ No major issues detected

Update review

---

🤖 Helpful? Please react with 👍/👎 | Questions❓Please reach out in Slack #ask-u-pr

[u-pr]

PR Code Suggestions ✨

No code suggestions found for the PR.

[codecov-github-com]

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff             @@
##           develop    #2359      +/-   ##
===========================================
- Coverage    77.90%   77.90%   -0.01%     
===========================================
  Files          476      476              
  Lines        97613    97612       -1     
===========================================
- Hits         76048    76040       -8     
- Misses       21565    21572       +7     

Flag	Coverage Δ
inputsystem_MacOS_2022.3	5.52% <ø> (-0.01%)	⬇️
inputsystem_MacOS_2022.3_project	75.39% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.0	5.30% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.0_project	77.29% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.3	5.31% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.3_project	77.29% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.4	5.31% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.4_project	77.30% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.5	5.31% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.5_project	77.29% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.6	5.31% <ø> (-0.01%)	⬇️
inputsystem_MacOS_6000.6_project	77.29% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_2022.3	5.53% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_2022.3_project	75.19% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.0	5.31% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.0_project	77.09% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.3	5.31% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.3_project	77.09% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.4	5.32% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.4_project	77.10% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.5	5.32% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.5_project	77.10% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.6	5.32% <ø> (-0.01%)	⬇️
inputsystem_Ubuntu_6000.6_project	77.10% <ø> (-0.01%)	⬇️
inputsystem_Windows_2022.3	5.53% <ø> (-0.01%)	⬇️
inputsystem_Windows_2022.3_project	75.52% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.0	5.30% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.0_project	77.42% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.3	5.31% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.3_project	77.42% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.4	5.31% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.4_project	77.42% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.5	5.31% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.5_project	77.42% <ø> (+<0.01%)	⬆️
inputsystem_Windows_6000.6	5.31% <ø> (-0.01%)	⬇️
inputsystem_Windows_6000.6_project	77.42% <ø> (-0.01%)	⬇️

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

Files with missing lines	Coverage Δ
...com.unity.inputsystem/InputSystem/InputSettings.cs	82.64% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

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

[MorganHoarau]

Such a great improvement, thank you!

[u-pr]

Persistent review updated to latest commit 0e5c3a5