Add lock options to requestPointerLock #49

NavidZ · 2019-07-16T20:28:52Z

The goal of this change is to allow application to access unadjusted mouse movement data while in Pointer Lock. This is a highly requested feature from partners in the gaming space. This change adds a PointerLockOptions object as a parameter to the requestPointerLock() method. The PointerLockOptions object currently only has one useful member which is the boolean unadjustedMovement. Also, to properly return error information and make it easier for developers to implement the requestPointerLock method was changed to return a promise.

The existing Pointer Lock API returns the mouse movement that the platforms give Chrome. By default all platforms include some form of mouse acceleration in the movement information they give Chrome. Mouse acceleration is the artificial increase of velocity when the mouse is moving fast. This is useful in normal use of the pointer when a user is trying to move the mouse across the screen. However, it also makes aiming in first person perspective games very difficult. To solve this problem we are adding an option to get that unadjusted movement data when requesting pointer lock.

With Pointer Lock options now available, applications need the ability to change those options while keeping the lock. This proves difficult using the previous API which fired changed or error events on the document to indicate the result of the request. Particularly troublesome was that the error event gave no reason. To solve this problem for developers a Promise workflow is being introduced. Now when requesting a change the developers can get actionable error information on rejected requests.

Example:

try {
  await element.requestPointerLock({ unadjustedMovement: true });
  console.log(“pointer lock acquired”);
} catch (error) {
  console.log(`Failed to acquire pointer lock due to ${error}`);
}

Closes #36

The following tasks have been completed:

Modified Web platform tests (TBD)

Implementation commitment:

WebKit Add unadjustedMovement option to requestPointerLock WebKit/WebKit#17525
Chromium (https://bugs.chromium.org/p/chromium/issues/detail?id=982379)
Gecko (TBD)

Preview | Diff

NavidZ · 2019-07-17T14:55:03Z

FYI @EiraGe

NavidZ · 2019-07-18T14:33:49Z

@BoCupp-Microsoft are you guys also interested in an API like this? Do you have any suggestions regarding the shape of the API?

@marcoscaceres What do you think of this API from Mozilla's perspective? Is that something you would be interested in implementing in FF? Also do you know who would be the best person from WebKit to ping about this?

marcoscaceres

Quick review and a couple of nits. Will try to get someone with knowledge in this area from Mozilla to let us know if this is something we want to add to Firefox. Will need a few days to get back to you.

index.html

marcoscaceres · 2019-07-18T15:07:44Z

@rniwa or @hober perhaps can provide some input from WebKit’s perspective?

index.html

marcoscaceres · 2019-08-20T02:54:31Z

Applied suggestions and fixed merge conflict.

Blocked on getting a second implementation.

NavidZ · 2019-08-20T19:33:07Z

@marcoscaceres did you find people on Mozilla that can consult more regarding this? maybe @smaug----?

NavidZ · 2019-08-20T19:33:39Z

@rniwa do you have any comments regarding this proposal?

marcoscaceres · 2019-08-21T04:23:10Z

Not yet, sorry. On it.

NavidZ · 2019-08-21T18:13:17Z

Also cc @juj as the requirement is very well expressed in @juj's comment

marcoscaceres · 2019-08-22T15:45:01Z

I was told that @smaug---- is indeed the right person from Mozilla to comment here 🙇 I also know they are super busy, so hopefully we will hear back soon.

smaug---- · 2019-08-30T17:52:38Z

(commented in the relevant issue #36 )

domenic

Really great to see this firming up! I left a first round of feedback that should get us started.

index.html

Experimental API proposed in w3c/pointerlock#49 and implemented in Chromium (crbug/982379) ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=291899961

Previously if a pointer lock request was made while the pointer was already locked it would update to the new element in the new request. However, now that we have options we must also allow the subsequent requests to change which options they are requesting for. Relevant Spec change: w3c/pointerlock#49 Bug: 1043640 Change-Id: I777f6de156554254c7a5ffbefcbe32e9d0af504e Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2071788 Commit-Queue: James Hollyer <jameshollyer@chromium.org> Reviewed-by: Dave Tapuska <dtapuska@chromium.org> Reviewed-by: Kinuko Yasuda <kinuko@chromium.org> Reviewed-by: Ken Buchanan <kenrb@chromium.org> Cr-Commit-Position: refs/heads/master@{#750032}

jameshollyergoogle

Domenic, thanks for all the reviews. I tried my best. I am sure there is still more to do. Let me know what you think.

index.html

JamesHollyer

Thanks again Domenic! Please check out these changes. I think it is starting to come along.

index.html

domenic

The model is looking very solid now. What remains are details of the algorithm flow, plus a good deal of editorial nits. (I would encourage you to do a once-over of the PR for grammar/spelling/capitalization consistency.)

But since the model is solid, those changes should be relatively easy. Hooray!

index.html

JamesHollyer

Thanks again. Can you find any other things that need fixing?

index.html

JamesHollyer · 2020-10-21T23:43:49Z

index.html

-            <code>screenY</code>, when the pointer is locked).
-          </p>
+          <ol>
+            <li>


JamesHollyer · 2020-10-21T23:44:45Z

index.html

+              If <a>pointer-lock target</a> is not in the same <a>shadow-including root</a> as <a>this</a>'s document, return.
+            </li>
+            <li>
+              if currently locked to a target whose <a>shadow-including root</a> is this document <a>exit pointer lock</a>


reillyeon · 2020-10-23T19:06:34Z

This seems close to merging. @smaug----, can you take another look?

index.html

JamesHollyer

A few big mistakes in the last version. Hopefully this one looks better.

index.html

ollop · 2021-05-28T10:56:58Z

Wondered if there is any progress on this. It is still not available by default in Chrome Version 91.0.4472.77 and the option to enable it is gone in 93.0.4525.0 canary. As we built something around "unadjustedMovement" I wondered if this will ever become available by default.

index.html

…accelerated-movements

index.html

james-howard

I added one small grammar comment, but otherwise looks good to me.

index.html

mustaqahmed

I am approving the PR but suggesting to add one more issue.

index.html

mustaqahmed · 2024-06-03T14:42:07Z

@marcoscaceres Is there an easy way to bypass or override the failing ipr check? @NavidZ is no longer a participant of WebApps WG.

mustaqahmed · 2024-06-05T20:20:55Z

For sake of making real progress on this old PR, I will "resolve" any open conversation that has been commented as "done". After that we will re-examine what's left then move to a brand new PR to bypass the "ipr" check.

mustaqahmed · 2024-06-06T14:15:14Z

Thanks @alvinjiooo for creating a new PR to be able to bypass "ipr" checks here. I will now close this PR and ask everyone to resume your review on #99 instead.

The "Changes requested" section above shows pending reviews from @marcoscaceres and @domenic. I spot-checked many comments there over the last few days, they seemed old and already resolved. I would request another quick re-review of #99 in case I missed something.

We are expecting to land #99 soon, before this PR hits its 5th anniversary 😞!

Thanks everyone here for your patient!!!

NavidZ requested a review from marcoscaceres July 17, 2019 14:54

marcoscaceres reviewed Jul 18, 2019

View reviewed changes

scheib reviewed Aug 19, 2019

View reviewed changes

index.html Outdated Show resolved Hide resolved

marcoscaceres added the DO NOT MERGE label Aug 20, 2019

domenic requested changes Jan 22, 2020

View reviewed changes

scheib mentioned this pull request Jun 2, 2020

Option needed to disable OS-level adjustment for mouse acceleration #36

Closed

jameshollyergoogle reviewed Aug 4, 2020

View reviewed changes

domenic reviewed Aug 10, 2020

View reviewed changes

JamesHollyer reviewed Sep 29, 2020

View reviewed changes

domenic reviewed Oct 2, 2020

View reviewed changes

JamesHollyer mentioned this pull request Oct 5, 2020

Pointer Lock Unadjusted Movement Option. mozilla/standards-positions#448

Open

JamesHollyer reviewed Oct 21, 2020

View reviewed changes

beaufortfrancois mentioned this pull request Oct 23, 2020

Add unadjustedMovement PointerLock option mdn/browser-compat-data#7021

Closed

domenic reviewed Oct 26, 2020

View reviewed changes

JamesHollyer reviewed Nov 18, 2020

View reviewed changes

kiding mentioned this pull request Jan 20, 2021

Pointer Lock API: unadjustedMovement Fyrd/caniuse#5744

Closed

alvinjiooo mentioned this pull request May 6, 2024

When a subsequent requestPointerLock is rejected, should an already locked target exit lock state? #91

Open

marcoscaceres reviewed May 7, 2024

View reviewed changes

index.html Outdated Show resolved Hide resolved

marcoscaceres reviewed May 7, 2024

View reviewed changes

index.html Outdated Show resolved Hide resolved

marcoscaceres reviewed May 7, 2024

View reviewed changes

index.html Outdated Show resolved Hide resolved

domenic removed their request for review May 7, 2024 02:03

Alvin Ji and others added 8 commits May 8, 2024 00:18

Remove <dfn> from options and merge note from PR#76

473ca5c

rebase

98fb95b

Introduce lock requests queue in requestPointerLock algorithm

68d1efa

Merge remote-tracking branch 'origin/unaccelerated-movements' into un…

6a6bd42

…accelerated-movements

tidy

6e31c6d

make this become [=this=] in requestPointerLock algorithm

1f8d34d

Merge branch 'gh-pages' into unaccelerated-movements

15b7ebb

remove uncessary <ul> which wrap <aside>

37bc6bc

alvinjiooo reviewed May 9, 2024

View reviewed changes

index.html Show resolved Hide resolved

james-howard reviewed May 10, 2024

View reviewed changes

index.html Outdated Show resolved Hide resolved

mustaqahmed approved these changes May 21, 2024

View reviewed changes

index.html Show resolved Hide resolved

alvinjiooo mentioned this pull request May 28, 2024

lock requests queue processing is incomplete #96

Open

Alvin Ji added 2 commits May 28, 2024 18:44

Associate issue 96 in algorithm of lock requests enqueue step

501820d

Merge branch 'gh-pages' into unaccelerated-movements

1de2cf8

alvinjiooo requested review from marcoscaceres and removed request for nondebug May 28, 2024 20:53

mustaqahmed mentioned this pull request May 28, 2024

Section 2.1 should mention the effect of lock on PointerEvents #97

Open

Associate issue#97 to pointer lock state paragraph

dbb58d1

mustaqahmed mentioned this pull request Jun 5, 2024

Add lock options to requestPointerLock #99

Merged

4 tasks

mustaqahmed closed this Jun 6, 2024

github-actions bot mentioned this pull request Jul 26, 2024

Convert noteblocks for web/api folder (part 4) mdn/content#35128

Merged

github-actions bot mentioned this pull request Sep 28, 2024

[zh-CN]: sync translation for Element.requestPointerLock() and Document.exitPointerLock() mdn/translated-content#23818

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add lock options to requestPointerLock #49

Add lock options to requestPointerLock #49

NavidZ commented Jul 16, 2019 •

edited by pr-preview bot

Loading

NavidZ commented Jul 17, 2019

NavidZ commented Jul 18, 2019

marcoscaceres left a comment

marcoscaceres commented Jul 18, 2019

marcoscaceres commented Aug 20, 2019

NavidZ commented Aug 20, 2019

NavidZ commented Aug 20, 2019

marcoscaceres commented Aug 21, 2019

NavidZ commented Aug 21, 2019

marcoscaceres commented Aug 22, 2019

smaug---- commented Aug 30, 2019

domenic left a comment

jameshollyergoogle left a comment

JamesHollyer left a comment

domenic left a comment

JamesHollyer left a comment

JamesHollyer Oct 21, 2020

JamesHollyer Oct 21, 2020

reillyeon commented Oct 23, 2020

JamesHollyer left a comment

ollop commented May 28, 2021

james-howard left a comment

mustaqahmed left a comment

mustaqahmed commented Jun 3, 2024

mustaqahmed commented Jun 5, 2024

mustaqahmed commented Jun 6, 2024

Add lock options to requestPointerLock #49

Add lock options to requestPointerLock #49

Conversation

NavidZ commented Jul 16, 2019 • edited by pr-preview bot Loading

NavidZ commented Jul 17, 2019

NavidZ commented Jul 18, 2019

marcoscaceres left a comment

Choose a reason for hiding this comment

marcoscaceres commented Jul 18, 2019

marcoscaceres commented Aug 20, 2019

NavidZ commented Aug 20, 2019

NavidZ commented Aug 20, 2019

marcoscaceres commented Aug 21, 2019

NavidZ commented Aug 21, 2019

marcoscaceres commented Aug 22, 2019

smaug---- commented Aug 30, 2019

domenic left a comment

Choose a reason for hiding this comment

jameshollyergoogle left a comment

Choose a reason for hiding this comment

JamesHollyer left a comment

Choose a reason for hiding this comment

domenic left a comment

Choose a reason for hiding this comment

JamesHollyer left a comment

Choose a reason for hiding this comment

JamesHollyer Oct 21, 2020

Choose a reason for hiding this comment

JamesHollyer Oct 21, 2020

Choose a reason for hiding this comment

reillyeon commented Oct 23, 2020

JamesHollyer left a comment

Choose a reason for hiding this comment

ollop commented May 28, 2021

james-howard left a comment

Choose a reason for hiding this comment

mustaqahmed left a comment

Choose a reason for hiding this comment

mustaqahmed commented Jun 3, 2024

mustaqahmed commented Jun 5, 2024

mustaqahmed commented Jun 6, 2024

NavidZ commented Jul 16, 2019 •

edited by pr-preview bot

Loading