Skip to content

Commit 1530297

Browse files
committed
Image fixes for consistency and web accessibility
- Applied consistent sizing for most component windows - Updated the alt text to comply with accessibility standards (not an exhaustive search; just the ones I happened to find) - Removed some images that were redundant or purely screen shots describing the UI elements that appear in the Editor (future-proofing)
1 parent bac9b88 commit 1530297

16 files changed

+62
-64
lines changed

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

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@ You can add multiple bindings to an action, which is generally useful for suppor
3535

3636
You can also bind multiple controls from the same device to an action. For example, both the left and right trigger of a gamepad could be mapped to the same action, so that pulling either trigger has the same result in your game.
3737

38-
![The default "move" action with its multiple bindings highlighted](./Images/ActionWithMultipleBindings.png)<br/>
39-
_The default "Move" action in the Actions Editor window, displaying the multiple bindings associated with it._
4038

4139

4240
Each Binding has the following properties:
@@ -97,9 +95,10 @@ There are currently five Composite types that come with the system out of the bo
9795

9896
### 1D axis
9997

100-
![Add 1D Axis Composite](./Images/Add1DAxisComposite.png)
98+
![The Add Positive/Negative Binding property is selected for the "fire" action on the Actions panel.](Images/Add1DAxisComposite.png){width="486" height="133"}
99+
100+
![The 1D Axis Composite binding appears under the "fire" action on the Actions panel.](Images/1DAxisComposite.png){width="486" height="142"}
101101

102-
![1D Axis Composite](./Images/1DAxisComposite.png)
103102

104103
A Composite made of two buttons: one that pulls a 1D axis in its negative direction, and another that pulls it in its positive direction. Implemented in the [`AxisComposite`](../api/UnityEngine.InputSystem.Composites.AxisComposite.html) class. The result is a `float`.
105104

@@ -137,9 +136,10 @@ If Controls from both the `positive` and the `negative` side are actuated, then
137136
138137
### 2D vector
139138

140-
![Add 2D Vector Composite](./Images/Add2DVectorComposite.png)
139+
![The Add Up/Down/Left/Right Composite binding is selected for the Move property on the Actions panel.](Images/Add2DVectorComposite.png){width="486" height="199"}
140+
141+
![The Add Up/Down/Left/Right Composite binding is selected for the "Move" action on the Actions panel.](Images/Add2DVectorComposite.png){width="486" height="199"}
141142

142-
![2D Vector Composite](./Images/2DVectorComposite.png)
143143

144144
A Composite that represents a 4-way button setup like the D-pad on gamepads. Each button represents a cardinal direction. Implemented in the [`Vector2Composite`](../api/UnityEngine.InputSystem.Composites.Vector2Composite.html) class. The result is a `Vector2`.
145145

@@ -180,9 +180,11 @@ In addition, you can set the following parameters on a 2D vector Composite:
180180
181181
### 3D vector
182182

183-
![Add 3D Vector Composite](./Images/Add3DVectorComposite.png)
184183

185-
![3D Vector Composite](./Images/3DVectorComposite.png)
184+
![The Add Up/Down/Left/Right/Forward/Backward Composite binding is selected for the "position" action on the Actions panel.](Images/Add3DVectorComposite.png){width="486" height="150"}
185+
186+
![The 3D Vector part bindings appear under the "position" action on the Actions panel.](Images/3DVectorComposite.png){width="486" height="259"
187+
}
186188

187189
A Composite that represents a 6-way button where two combinations each control one axis of a 3D vector. Implemented in the [`Vector3Composite`](../api/UnityEngine.InputSystem.Composites.Vector3Composite.html) class. The result is a `Vector3`.
188190

@@ -220,9 +222,10 @@ In addition, you can set the following parameters on a 3D vector Composite:
220222

221223
### One Modifier
222224

223-
![Add Binding With One Modifier](./Images/AddBindingWithOneModifier.png)
224225

225-
![One Modifier Composite](./Images/OneModifierComposite.png)
226+
![The Add Binding With One Modifier Composite binding is selected for the "fire" action on the Actions panel.](Images/AddBindingWithOneModifier.png){width="486" height="129"}
227+
228+
![The One Modifier part bindings appear under the "fire" action on the Actions panel.](Images/OneModifierComposite.png){width="486" height="147"}
226229

227230
A Composite that requires the user to hold down a "modifier" button in addition to another control from which the actual value of the Binding is determined. This can be used, for example, for Bindings such as "SHIFT+1". Implemented in the [`OneModifierComposite`](../api/UnityEngine.InputSystem.Composites.OneModifierComposite.html) class. The buttons can be on any Device, and can be toggle buttons or full-range buttons such as gamepad triggers.
228231

@@ -252,9 +255,11 @@ This Composite has no parameters.
252255

253256
### Two Modifiers
254257

255-
![Add Bindings With Two Modifiers](./Images/AddBindingWithTwoModifiers.png)
256258

257-
![Two Modifiers Composite](./Images/TwoModifiersComposite.png)
259+
![The Bindings With Two Modifiers Composite binding is selected for the "fire" action on the Actions panel.](Images/AddBindingWithTwoModifiers.png){width="486" height="119"}
260+
261+
![The Two Modifiers part bindings appear under the "fire" action on the Actions panel.](Images/TwoModifiersComposite.png){width="486" height="149"}
262+
258263

259264
A Composite that requires the user to hold down two "modifier" buttons in addition to another control from which the actual value of the Binding is determined. This can be used, for example, for Bindings such as "SHIFT+CTRL+1". Implemented in the [`TwoModifiersComposite`](../api/UnityEngine.InputSystem.Composites.TwoModifiersComposite.html) class. The buttons can be on any Device, and can be toggle buttons or full-range buttons such as gamepad triggers.
260265

@@ -960,4 +965,4 @@ By default, [Button](RespondingToActions.md#button) and [Pass-Through](Respondin
960965

961966
However, you can manually enable initial state checks on these types of Actions using the checkbox in the editor:
962967

963-
![Initial State Check](./Images/InitialStateCheck.png)
968+
![The Initial State Check setting appears with a checkmark under the Pass Through action on the Action panel.](./Images/InitialStateCheck.png){width="486" height="116"}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The association between an Action and the device controls which perform that inp
1111

1212
To use actions in your code, you must use the [Input Actions editor](ActionsEditor.md) to establish the mapping between the Action and one or more device controls. For example in this screenshot, the "Move" action is displayed, showing its bindings the left gamepad stick, and the keyboard's arrow keys.
1313

14-
![Actions Bindings](Images/ActionsBinding.png)<br/>
14+
![](Images/ActionsBinding.png)<br/>
1515
*The Actions panel of the Input Actions Editor in Project Settings*
1616

1717
You can then get a reference to this action in your code, and check its value, or attach a callback method to be notified when it is performed. See the [Actions Workflow page](Workflow-Actions.md) for a simple example script demonstrating this.

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

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ The **Input Actions Editor** is an editor window displayed when you open an Acti
1919

2020
It is also displayed in the Project Settings window under **Edit** > **Project Settings** > **Input System Package** if you have an Action Asset assigned as project-wide.
2121

22-
![image alt text](./Images/ActionsEditorCallout.png)
23-
*The Input Actions editor, displaying the default actions*
22+
![](./Images/ActionsEditorCallout.png)
23+
*The Input Actions editor, displaying the three panels and the default actions*
2424

2525
### The Actions Editor panels
2626

@@ -82,18 +82,18 @@ There are more specific control types available which further filter the availab
8282

8383
You can add multiple bindings to an action, which is generally useful for supporting multiple types of input device. For example, in the default set of actions, the "Move" action has a binding to the left gamepad stick and the WSAD keys, which means input through any of these bindings will perform the action.
8484

85-
![The default "move" action with its multiple bindings highlighted](./Images/ActionWithMultipleBindings.png)<br/>
86-
_The default "Move" action in the Actions Editor window, displaying the multiple bindings associated with it._
85+
![](./Images/ActionWithMultipleBindings.png)<br/>
86+
_The default Move action in the Actions Editor window, displaying the multiple bindings associated with it._
8787

8888
If you select a Binding, you can edit its properties in the right-hand pane of the window:
8989

90-
![Binding Properties](Images/BindingProperties.png)
90+
![The Binding Properties panel displays the Path value as Left Stick [Gamepad].](Images/BindingProperties.png)
9191

9292
#### Picking Controls
9393

94-
The most important property of any Binding is the [control path](Controls.md#control-paths) it's bound to. To edit it, open the __Path__ drop-down list. This displays a Control picker window.
94+
The most important property of any Binding is the [control path](Controls.md#control-paths) it's bound to. To edit it, open the __Path__ dropdown menu. This displays a Control picker window.
9595

96-
![Control Picker](Images/InputControlPicker.png)
96+
![The Binding Properties panel displays the Control Picker window available from the Path dropdown menu.](Images/InputControlPicker.png)
9797

9898
In the Control picker window, you can explore a tree of Input Devices and Controls that the Input System recognizes, and bind to these Controls. Unity filters this list by the Action's [`Control Type`](../api/UnityEngine.InputSystem.InputAction.html#UnityEngine_InputSystem_InputAction_expectedControlType) property. For example, if the Control type is `Vector2`, you can only select a Control that generates two-dimensional values, like a stick.
9999

@@ -107,11 +107,12 @@ Finally, you can choose to manually edit the Binding path, instead of using the
107107

108108
Composite Bindings are Bindings consisting of multiple parts, which form a Control together. For instance, a [2D Vector Composite](ActionBindings.md#2d-vector) uses four buttons (left, right, up, down) to simulate a 2D stick input. See the [Composite Bindings](ActionBindings.md#composite-bindings) documentation to learn more.
109109

110-
![2D Vector Composite](./Images/2DVectorComposite.png)
110+
![The WASD setting appears under the Move property on the Actions panel.](Images/2DVectorComposite.png){width="486" height="178"}
111+
111112

112113
To create a Composite Binding, in the Input Action Asset editor window, select the Add (+) icon on the Action you want to add it to, and select the Composite Binding type from the popup menu.
113114

114-
![Add 2D Vector Composite](./Images/Add2DVectorComposite.png)
115+
![The Add Up/Down/Left/Right Composite binding is selected for the Move property on the Actions panel.](Images/Add2DVectorComposite.png){width="486" height="199"}
115116

116117
This creates multiple Binding entries for the Action: one for the Composite as a whole, and then, one level below that, one for each Composite part. The Composite itself doesn't have a Binding path property, but its individual parts do, and you can edit these parts like any other Binding. Once you bind all the Composite's parts, the Composite can work together as if you bound a single control to the Action.
117118

@@ -120,21 +121,21 @@ This creates multiple Binding entries for the Action: one for the Composite as a
120121
121122
To change the type of a Composite retroactively, select the Composite, then select the new type from the **Composite Type** drop-down in the **Properties** pane.
122123

123-
![Composite Type](./Images/CompositeType.png)
124+
![The Composite Type binding is set to 2D Vector binding on the Actions panel.](./Images/CompositeType.png){width="486" height="184"}
124125

125126
To change the part of the Composite to which a particular Binding is assigned, use the **Composite Part** drop-down in the Binding's properties.
126127

127-
![Composite Part](./Images/CompositePart.png)
128+
![The Composite Part binding is set to Up under the Path binding property.](./Images/CompositePart.png){width="486" height="161"}
128129

129130
You can assign multiple Bindings to the same part. You can also duplicate individual part Bindings: right-click the Binding, then select **Duplicate** to create new part Bindings for the Composite. This can be used, for example, to create a single Composite for both "WASD" style controls and arrow keys.
130131

131-
![Duplicated Part Bindings](./Images/DuplicatedPartBindings.png)
132+
![The Keyboard setting under Move on the Actions panel displays duplicated part bindings.](./Images/DuplicatedPartBindings.png){width="486" height="214"}
132133

133134
### Editing Control Schemes
134135

135136
Input Action Assets can have multiple [Control Schemes](ActionBindings.md#control-schemes), which let you enable or disable different sets of Bindings for your Actions for different types of Devices.
136137

137-
![Control Scheme Properties](Images/ControlSchemeProperties.png)
138+
![Gamepad appears as the Scheme Name value on the Add Control Scheme window.](Images/ControlSchemeProperties.png)
138139

139140
To see the Control Schemes in the Input Action Asset editor window, open the Control Scheme drop-down list in the top left of the window. This menu lets you add or remove Control Schemes to your Actions Asset. If the Actions Asset contains any Control Schemes, you can select a Control Scheme, and then the window only shows bindings that are associated with that Scheme. If you select a binding, you can now pick the Control Schemes for which this binding should be active in the __Properties__ view to the left of the window.
140141

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

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The Input Debugger displays a tree breakdown of the state of the Input System.
4040

4141
In the Input Debugger window, navigate to the __Devices__ list and double-click any [Input Device](Devices.md). This opens a window that displays information about the Device, including real-time state information for its Controls.
4242

43-
![Device in Input Debugger](Images/DeviceInDebugger.png)
43+
![The Unity Editor window displays the Analysis option selected from the Window menu, and the Input Debugger option selected from the Analysis submenu to demonstrate how to access the devices in the Input Debugger tab.](Images/DeviceInDebugger.png)
4444

4545
The top of the Device window displays general information about the specific Device, such as name, manufacturer, associated layout, device flags, device ID and serial number. In addition, this section also display the current __sample frequency__ and __processing delay__ of the deivce.
4646

@@ -67,14 +67,10 @@ The Input Debugger window lists all enabled [Actions](Actions.md) in the __Actio
6767

6868
When there are [`InputUser`](UserManagement.md) instances (if you use `PlayerInput`, each `PlayerInput` instance implicitly creates one), the Input Debugger's __Users__ list displays each instance along with its paired Devices and active Actions. The listed Devices and Actions work the same way as those displayed in the [__Devices__](#debugging-devices) and [__Actions__](#debugging-actions) lists in the debugging window.
6969

70-
![Users in Input Debugger](Images/UsersInputDebugger.png)
71-
7270
### Debugging layouts
7371

7472
The [__Layouts__](Layouts.md) list in the Input Debugger window displays a breakdown of all registered [Control and Device layouts](Layouts.md). This is the database of supported hardware and the knowledge of how to represent a given piece of input hardware. It's useful when you want to [create a new Device mapping](HID.md#creating-a-custom-device-layout) and see how the Input System represents it.
7573

76-
![Layouts in Input Debugger](Images/LayoutsInDebugger.png)
77-
7874
### Debugging remotely
7975

8076
You can connect the Input Debugger to a Player that runs on a remote computer or device. This makes it possible to observe input activity from the Player in the Editor. This connection uses the `PlayerConnection` mechanism, which is the same one the Unity profiler uses to connect to a Player.
@@ -96,13 +92,13 @@ The sample provides two visualizer components:
9692

9793
Visualizes the current state of a single Control in real time. You can have multiple Control visualizers to visualize the state of multiple Controls. Check the `GamepadVisualizer`, `MouseVisualizer`, or `PenVisualizer` Scenes in the sample for examples.
9894

99-
![InputControlVisualizer](Images/InputControlVisualizer.png)
95+
![LeftTrigger and Y appear in green in the InputControlVisualizer to show they are selected.](Images/InputControlVisualizer.png)
10096

10197
### `InputActionVisualizer`
10298

10399
Visualizes the current state of a single Action in real time. You can have multiple Action visualizers to visualize the state of multiple Actions. This can also display the current value of the Action and the Control currently driving the Action, and track the state of [Interactions](Interactions.md) over time. Check the `SimpleControlsVisualizer` Scene in the sample for examples.
104100

105-
![InputActionVisualizer](Images/InputActionVisualizer.png)
101+
![The Fire Action appears in green in the InputActionVisualizer to show it is selected.](Images/InputActionVisualizer.png)
106102

107103
## Device Simulator
108104

-209 KB
Binary file not shown.
-127 KB
Binary file not shown.
-220 KB
Binary file not shown.
-20.7 KB
Binary file not shown.
-270 KB
Binary file not shown.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ An Interaction represents a specific input pattern. For example, a [hold](#hold)
2424

2525
Interactions drive responses on Actions. You can place them on individual Bindings or an Action as a whole, in which case they apply to every Binding on the Action. At runtime, when a particular interaction completes, this triggers the Action.
2626

27-
![Interaction Properties](Images/InteractionProperties.png)
27+
![The Binding Path displays the buttonSouth [Gamepad] value set on the Interaction Properties window.](Images/InteractionProperties.png){width="486" height="585"}
2828

2929
## Operation
3030

0 commit comments

Comments
 (0)