DOCS: How to use processors #2171

ritamerkl · 2025-04-23T15:02:53Z

Description

This adds more documentation on how to use processors.

Testing status & QA

No testing

Overall Product Risks

Complexity: low
Halo Effect: low

Comments to reviewers

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.

…es/InputSystem into docs-processors

lilisha-unity

I did my first pass on the PR. Please fix the note formatting and replace the placeholder image alt text with something more descriptive. Also, there are quite a few sentences written in passive voice—please rewrite them in active voice where appropriate. You can refer to the Unity style guide for reference: https://docs-style-guide.unity.com/style/use-active-voice.

Packages/com.unity.inputsystem/Documentation~/HowToApplyProcessors.md

Packages/com.unity.inputsystem/Documentation~/ProcessorTypes.md

Packages/com.unity.inputsystem/Documentation~/HowToApplyProcessors.md

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

…sors.md Co-authored-by: lilisha-unity <[email protected]>

Co-authored-by: lilisha-unity <[email protected]>

…sors.md Co-authored-by: lilisha-unity <[email protected]>

Co-authored-by: lilisha-unity <[email protected]>

codecov-github-com · 2025-05-27T17:33:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff             @@
##           develop    #2171      +/-   ##
===========================================
- Coverage    67.81%   67.78%   -0.03%     
===========================================
  Files          367      367              
  Lines        53513    53513              
===========================================
- Hits         36288    36276      -12     
- Misses       17225    17237      +12

Flag	Coverage Δ
mac_2021.3_pkg	`5.41% <ø> (ø)`
mac_2021.3_project	`70.42% <ø> (ø)`
mac_2022.3_pkg	`5.19% <ø> (ø)`
mac_2022.3_project	`65.29% <ø> (ø)`
mac_6000.0_pkg	`5.20% <ø> (ø)`
mac_6000.0_project	`67.72% <ø> (+<0.01%)`	⬆️
mac_6000.1_pkg	`5.20% <ø> (ø)`
mac_6000.1_project	`67.71% <ø> (-0.02%)`	⬇️
mac_6000.2_pkg	`5.20% <ø> (ø)`
mac_6000.2_project	`67.71% <ø> (ø)`
mac_trunk_pkg	`5.20% <ø> (ø)`
mac_trunk_project	`67.71% <ø> (ø)`
win_2021.3_pkg	`5.42% <ø> (ø)`
win_2021.3_project	`70.49% <ø> (ø)`
win_2022.3_pkg	`5.20% <ø> (ø)`
win_2022.3_project	`65.37% <ø> (+<0.01%)`	⬆️
win_6000.0_pkg	`5.20% <ø> (ø)`
win_6000.0_project	`67.78% <ø> (+0.09%)`	⬆️
win_6000.1_pkg	`5.20% <ø> (ø)`
win_6000.1_project	`67.78% <ø> (ø)`
win_6000.2_pkg	`5.20% <ø> (ø)`
win_6000.2_project	`67.78% <ø> (+<0.01%)`	⬆️
win_trunk_pkg	`5.20% <ø> (ø)`
win_trunk_project	`67.78% <ø> (+0.10%)`	⬆️

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

see 3 files with indirect coverage changes

🚀 New features to boost your workflow:

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

lilisha-unity

Finished my review with some suggestions.

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

Co-authored-by: lilisha-unity <[email protected]>

…es/InputSystem into docs-processors

ekcoh

Looks good to me, added some minor comments

Packages/com.unity.inputsystem/Documentation~/HowToApplyProcessors.md

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

ekcoh · 2025-06-11T14:07:11Z

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

+
+#### Example: Racing game speend control
+
+In a case where the player is not supposed to fall below a certain base speed, but also cannot exceed a certain maximum speed, the Clamp Processor is the one you may want to use.


Generally, IMO this to be game-logic and not input logic, but its fine as-is to show as example.

ekcoh · 2025-06-11T14:09:37Z

Looks like there is some CI issues that needs attention

jfreire-unity

Thanks, an important improvement for our docs!
I added some minor suggestions.
Mostly nitpicks around using "Processors" and "processors". I probably didn't catch them all, but it would be good to always use the same.

Packages/com.unity.inputsystem/Documentation~/ActionBindings.md

Packages/com.unity.inputsystem/Documentation~/ProcessorTypes.md

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

jfreire-unity · 2025-06-12T12:05:49Z

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

+    "invert,normalize(min=0,max=10)"
+```
+
+## Choose the right Processor


Great section 👏

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

jfreire-unity · 2025-06-12T12:09:18Z

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

+The [Scale Processor](ProcessorTypes.md#scale) multiplies the input value by a given factor X. This applies to float values as well as vectors, where each axis is multiplied by the corresponding factor specified for that axis.
+This allows you to assign weight to input values, which can, for example, make a particular type of control easier to use.
+
+#### Example: Horizontally aligned Camera


I don't think it makes sense to add now but I feel it can be mentioned. This example would be a great shout out to another package users might not be aware of, such as Cinemachine!

Co-authored-by: João Freire <[email protected]>

ritamerkl added 2 commits April 17, 2025 16:42

restructure processors documentation

55f2803

added scenarios for each processor

8472341

ritamerkl marked this pull request as draft April 23, 2025 15:05

ritamerkl added 6 commits April 25, 2025 17:32

uniforming scenarios & explanation and adding more details

1bfff7b

added pictures and code

db25dc2

refined scenarios and added pictures

5e9ee17

added example for clamp processor with picture

d37dcd5

replaced image for clamp processor

c824127

corrected grammar and spelling

32317b2

ritamerkl marked this pull request as ready for review April 29, 2025 13:32

Merge branch 'develop' into docs-processors

c365673

ritamerkl requested a review from jfreire-unity April 29, 2025 13:32

ritamerkl added 5 commits April 29, 2025 15:46

fixed formatting

1218ba0

Merge branch 'docs-processors' of https://github.com/Unity-Technologi…

bbea9d6

…es/InputSystem into docs-processors

updated file references to processors

3bc0a6e

fixed docs link

58a726e

Fixed Doc link

bc03750

LeoUnity requested a review from JonMUnity May 1, 2025 12:26

lilisha-unity requested changes May 9, 2025

View reviewed changes

jfreire-unity reviewed May 15, 2025

View reviewed changes

Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md Outdated Show resolved Hide resolved

ritamerkl and others added 10 commits May 27, 2025 15:39

Update Packages/com.unity.inputsystem/Documentation~/HowToApplyProces…

0c8f1db

…sors.md Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/ProcessorTypes.md

518e2dc

Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/ProcessorTypes.md

cda1e1d

Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/HowToApplyProces…

bda4aba

…sors.md Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/HowToApplyProces…

80d8410

…sors.md Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

31b1c1e

Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

4b22e08

Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

45e2105

Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

c1b6852

Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

9dab870

Co-authored-by: lilisha-unity <[email protected]>

ritamerkl and others added 7 commits May 27, 2025 15:44

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

bfa2d22

Co-authored-by: lilisha-unity <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

75fb0e0

Co-authored-by: lilisha-unity <[email protected]>

remove TOC for autogenerated TOC

72361ec

fixed alt text for normalize example

8f5bf2c

fixed clamp picture alt text

834e2c4

reworked alt text for images

8988c27

Merge branch 'develop' into docs-processors

9393fbc

lilisha-unity approved these changes May 28, 2025

View reviewed changes

ritamerkl and others added 7 commits May 28, 2025 18:13

added formatting to Notes

801884f

Apply suggestions from code review

542f977

Co-authored-by: lilisha-unity <[email protected]>

fixed note comment

58d212b

Merge branch 'docs-processors' of https://github.com/Unity-Technologi…

c90e7fb

…es/InputSystem into docs-processors

change to active language

cf18c91

fix formatting

3e09334

Merge branch 'develop' into docs-processors

9a47d3b

ekcoh approved these changes Jun 11, 2025

View reviewed changes

ritamerkl and others added 2 commits June 12, 2025 13:45

Adapt review suggestions

6614285

Merge branch 'develop' into docs-processors

644fb2e

ritamerkl requested review from jfreire-unity and removed request for JonMUnity June 12, 2025 11:55

jfreire-unity approved these changes Jun 12, 2025

View reviewed changes

ritamerkl and others added 5 commits June 12, 2025 14:15

Update Packages/com.unity.inputsystem/Documentation~/ActionBindings.md

0bc5fb1

Co-authored-by: João Freire <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/ProcessorTypes.md

9cf8111

Co-authored-by: João Freire <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

ffc478b

Co-authored-by: João Freire <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

10210b4

Co-authored-by: João Freire <[email protected]>

Update Packages/com.unity.inputsystem/Documentation~/UsingProcessors.md

52f2dba

Co-authored-by: João Freire <[email protected]>

ritamerkl merged commit 05635ca into develop Jun 13, 2025
131 checks passed

ritamerkl deleted the docs-processors branch June 13, 2025 08:38


		#### Example: Racing game speend control

		In a case where the player is not supposed to fall below a certain base speed, but also cannot exceed a certain maximum speed, the Clamp Processor is the one you may want to use.

DOCS: How to use processors #2171

DOCS: How to use processors #2171

Uh oh!

Conversation

ritamerkl commented Apr 23, 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!

lilisha-unity left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

lilisha-unity left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ekcoh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ekcoh Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

ekcoh commented Jun 11, 2025

Uh oh!

jfreire-unity left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jfreire-unity Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jfreire-unity Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ritamerkl commented Apr 23, 2025 •

edited

Loading

codecov-github-com bot commented May 27, 2025 •

edited

Loading