-
Notifications
You must be signed in to change notification settings - Fork 328
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.
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
DOCS: Specifying mouse position and delta behaviour #2028
Conversation
…between position and delta. This is to help clarify ISXB-819
|
|
||
| /// <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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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> | ||
| /// 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest changing this similarly.
…ttps://github.com/Unity-Technologies/InputSystem into DOCS__Specifying_mouse_position_and_delta_behaviour
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Moved new docs to <remarks> section, and improved wording.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved with changes applied direct to branch.
Description
Added documentation in Mouse.cs to specify the independent behaviour between position and delta. This is to help clarify ISXB-819
Changes made
Added a few comment lines in Mouse.cs
Testing
Risk
Docs only change. No technical risk.
Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.After merge: