Skip to content

Commit c6f8f99

Browse files
authored
doc amendments
Moved new docs to <remarks> section, and improved wording.
1 parent 6efecc3 commit c6f8f99

File tree

1 file changed

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

1 file changed

+4
-2
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,25 @@ 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. 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.
26+
/// Screen-space position of the mouse in pixels.
2727
/// </summary>
2828
/// <value>Position of mouse on screen.</value>
2929
/// <remarks>
3030
/// On Windows, delta originates from RAWINPUT API.
31+
/// Note: This value might not update every frame, particularly if your project is running at a high frame rates. This value might also update at a different time than the <see cref="Pointer.delta"/>. If you need a delta value that correlates with position, you should compute it based on the previous position value.
3132
/// </remarks>
3233
/// <seealso cref="Pointer.position"/>
3334
[InputControl(usage = "Point", dontReset = true)] // Mouse should stay put when we reset devices.
3435
[FieldOffset(0)]
3536
public Vector2 position;
3637

3738
/// <summary>
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.
39+
/// Screen-space motion delta of the mouse in pixels.
3940
/// </summary>
4041
/// <value>Mouse movement.</value>
4142
/// <remarks>
4243
/// On Windows, delta originates from RAWINPUT API.
44+
/// Note: This value might not update every frame, particularly if your project is running at a high frame rates. This value might also update at a different time than the <see cref="Pointer.position"/>. If you need a delta value that correlates with position, you should compute it based on the previous position value.
4345
/// </remarks>
4446
/// <seealso cref="Pointer.delta"/>
4547
[InputControl(usage = "Secondary2DMotion", layout = "Delta")]

0 commit comments

Comments
 (0)