Skip to content

DOCS: Specifying mouse position and delta behaviour #2028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 12, 2024
Merged

DOCS: Specifying mouse position and delta behaviour #2028

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4beeea7
Added documentation in Mouse.cs to specify the independent behaviour …
adrian-koretski-unity3d Oct 16, 2024
a183c21
Merge branch 'develop' into DOCS__Specifying_mouse_position_and_delta…
adrian-koretski-unity3d Oct 16, 2024
eb576b4
Adjusted mouse.cs positions and delta documentation.
adrian-koretski-unity3d Oct 17, 2024
6efecc3
Merge branch 'DOCS__Specifying_mouse_position_and_delta_behaviour' of…
adrian-koretski-unity3d Oct 17, 2024
c6f8f99
doc amendments
duckets Nov 7, 2024
1d75cc5
Merge branch 'develop' into DOCS__Specifying_mouse_position_and_delta…
adrian-koretski-unity3d Nov 7, 2024
e037010
Merge branch 'develop' into DOCS__Specifying_mouse_position_and_delta…
adrian-koretski-unity3d Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Packages/com.unity.inputsystem/InputSystem/Devices/Mouse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public struct MouseState : IInputStateTypeInfo
public static FourCC Format => new FourCC('M', 'O', 'U', 'S');

/// <summary>
/// Screen-space position of the mouse in pixels.
/// 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to remember this is a platform-agnostic API. I would suggest changing "Updated", which is given, to "May be updated independently from delta depending on the platform."

Then you may add to remarks: "On Windows, delta originates from RAWINPUT API." or leave that out.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"If a delta is needed that correlates with position, compute it based on the last reported position".

/// </summary>
/// <value>Position of mouse on screen.</value>
/// <seealso cref="Pointer.position"/>
Expand All @@ -32,7 +32,7 @@ public struct MouseState : IInputStateTypeInfo
public Vector2 position;

/// <summary>
/// Screen-space motion delta of the mouse in pixels.
/// 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest changing this similarly.

/// </summary>
/// <value>Mouse movement.</value>
/// <seealso cref="Pointer.delta"/>
Expand Down