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.

lilisha-unity · 2025-05-07T20:05:02Z

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

+---
+uid: input-system-processors
+---
+# How to apply Processors


Suggested change

# How to apply Processors

# Apply Processors

lilisha-unity · 2025-05-07T20:06:37Z

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

@@ -1,16 +1,10 @@
 ---
 uid: input-system-processors
 ---
-# Processors
+# Processor Types


Suggested change

# Processor Types

# Processor types

lilisha-unity · 2025-05-07T20:09:01Z

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


-An Input Processor takes a value and returns a processed result for it. The received value and result value must be of the same type. For example, you can use a [clamp](#clamp) Processor to clamp values from a control to a certain range.
+Below you will find predefined processors, furthermore it's possible to create custom Processors. For more information on when to use which type of processor please refer to [Using Processors](UsingProcessors.md).


Suggested change

Below you will find predefined processors, furthermore it's possible to create custom Processors. For more information on when to use which type of processor please refer to [Using Processors](UsingProcessors.md).

Below are predefined processors. You can also create custom Processors. For guidance on when to use each type, refer to [Using Processors](UsingProcessors.md).

lilisha-unity · 2025-05-08T21:50:23Z

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

+---
+# How to apply Processors
+
+The particularities between the three different ways of applying Processors to input events. For more information on the general usage of Processors refer to [Using Processors](UsingProcessors.md).


Suggested change

The particularities between the three different ways of applying Processors to input events. For more information on the general usage of Processors refer to [Using Processors](UsingProcessors.md).

The following are the three different ways of applying Processors to input events. For more information on the general usage of Processors, refer to [Using Processors](UsingProcessors.md).

lilisha-unity · 2025-05-08T21:59:13Z

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

+
+When you create Bindings for your [actions](Actions.md), you can choose to add Processors to the Bindings. These process the values from the controls they bind to, before the system applies them to the Action value. For instance, you might want to invert the `Vector2` values from the controls along the Y axis before passing these values to the Action that drives the input logic for your application. To do this, you can add an [Invert Vector2](ProcessorTypes.md#invert-vector-2) Processor to your Binding.
+
+If you're using Actions defined in the [Input Actions Editor](ActionsEditor.md), or in an  [Action Asset](ActionAssets.md), you can add any Processor to your Bindings in the Input Action editor. Select the Binding you want to add Processors to so that the right pane of the window displays the properties for that Binding. Select the Add (+) icon on the __Processors__ foldout to open a list of all available Processors that match your control type, then choose a Processor type to add a Processor instance of that type. The Processor now appears under the __Processors__ foldout. If the Processor has any parameters, you can edit them in the __Processors__ foldout.


Suggested change

If you're using Actions defined in the [Input Actions Editor](ActionsEditor.md), or in an [Action Asset](ActionAssets.md), you can add any Processor to your Bindings in the Input Action editor. Select the Binding you want to add Processors to so that the right pane of the window displays the properties for that Binding. Select the Add (+) icon on the __Processors__ foldout to open a list of all available Processors that match your control type, then choose a Processor type to add a Processor instance of that type. The Processor now appears under the __Processors__ foldout. If the Processor has any parameters, you can edit them in the __Processors__ foldout.

If you're using Actions defined in the [Input Actions Editor](ActionsEditor.md), or in an [Action Asset](ActionAssets.md), you can add any Processor to your Bindings in the Input Action editor:

1. Select the Binding you want to add Processors to so that the right pane of the window displays the properties for that Binding.

2. Select the **Add (+)** icon on the __Processors__ foldout to open a list of all available Processors that match your control type.

3. Choose a Processor type to add a Processor instance of that type. The Processor now appears under the __Processors__ foldout.

4. (Optional) If the Processor has any parameters, you can edit them in the __Processors__ foldout.

lilisha-unity · 2025-05-09T18:59:37Z