Skip to content
8 changes: 8 additions & 0 deletions Packages/com.unity.inputsystem/InputSystem/Devices/Mouse.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ public struct MouseState : IInputStateTypeInfo
/// Screen-space position of the mouse in pixels.
/// </summary>
/// <value>Position of mouse on screen.</value>
/// <remarks>
/// On Windows, delta originates from RAWINPUT API.
/// 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.
/// </remarks>
/// <seealso cref="Pointer.position"/>
[InputControl(usage = "Point", dontReset = true)] // Mouse should stay put when we reset devices.
[FieldOffset(0)]
Expand All @@ -35,6 +39,10 @@ public struct MouseState : IInputStateTypeInfo
/// Screen-space motion delta of the mouse in pixels.
/// </summary>
/// <value>Mouse movement.</value>
/// <remarks>
/// On Windows, delta originates from RAWINPUT API.
/// 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.
/// </remarks>
/// <seealso cref="Pointer.delta"/>
[InputControl(usage = "Secondary2DMotion", layout = "Delta")]
[FieldOffset(8)]
Expand Down