Skip to content

Commit eb576b4

Browse files
Adjusted mouse.cs positions and delta documentation.
1 parent 4beeea7 commit eb576b4

File tree

1 file changed

+8
-2
lines changed
  • Packages/com.unity.inputsystem/InputSystem/Devices

1 file changed

+8
-2
lines changed

Packages/com.unity.inputsystem/InputSystem/Devices/Mouse.cs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,24 @@ public struct MouseState : IInputStateTypeInfo
2323
public static FourCC Format => new FourCC('M', 'O', 'U', 'S');
2424

2525
/// <summary>
26-
/// Screen-space position of the mouse in pixels. Updated independently from delta using WM. At high framerates, certain frames might not receive any new position data.
26+
/// Screen-space position of the mouse in pixels. May be updated independently from delta depending on the platform. At high framerates, certain frames might not receive any new position data. If a delta is needed that correlates with position, compute it based on the last reported position.
2727
/// </summary>
2828
/// <value>Position of mouse on screen.</value>
29+
/// <remarks>
30+
/// On Windows, delta originates from RAWINPUT API.
31+
/// </remarks>
2932
/// <seealso cref="Pointer.position"/>
3033
[InputControl(usage = "Point", dontReset = true)] // Mouse should stay put when we reset devices.
3134
[FieldOffset(0)]
3235
public Vector2 position;
3336

3437
/// <summary>
35-
/// Screen-space motion delta of the mouse in pixels. Updated independently from position using raw mouse input. At high framerates, certain frames might not receive any new delta data.
38+
/// Screen-space motion delta of the mouse in pixels. May be updated independently from position depending on the platform. At high framerates, certain frames might not receive any new delta data. If a delta is needed that correlates with position, compute it based on the last reported position.
3639
/// </summary>
3740
/// <value>Mouse movement.</value>
41+
/// <remarks>
42+
/// On Windows, delta originates from RAWINPUT API.
43+
/// </remarks>
3844
/// <seealso cref="Pointer.delta"/>
3945
[InputControl(usage = "Secondary2DMotion", layout = "Delta")]
4046
[FieldOffset(8)]

0 commit comments

Comments
 (0)