Add algorithms for getGamepads and events #151

nondebug · 2021-06-10T18:20:19Z

Closes #114

The following tasks have been completed:

Modified Web platform tests (link to pull request)

Implementation commitment:

WebKit (https://bugs.webkit.org/show_bug.cgi?id=)
Chromium (https://bugs.chromium.org/p/chromium/issues/detail?id=)
Gecko (https://bugzilla.mozilla.org/show_bug.cgi?id=)

Preview | Diff

Fixes #114

marcoscaceres

Great stuff @nondebug! I didn't manage to get all the way through it yet, but here is the initial set of comments.

marcoscaceres · 2021-06-11T04:15:34Z

index.html

+          <td>A flag indicating that the {{Gamepad}} object has been exposed to script.
+        <tr>
+          <td><dfn>[[\axisMapping]]</dfn>
+          <td>`{}`


In the internal slots, we can switch to using infra types. That gives us nicer ways of working with things.

Suggested change

<td>`{}`

<td>An empty [=ordered map=].

Sounds good for these internal arrays. I've left the Navigator.gamepads list as an empty array [] since we need to expose that array to script for getGamepads. Is there some incantation for converting from infra types to Javascript types?

index.html

marcoscaceres · 2021-06-11T07:09:01Z

index.html

+      <p>
+        The <a>user agent</a> MUST provide methods for retrieving <dfn data-lt="ordered array of axis inputs">ordered arrays of axis inputs</dfn> and <dfn data-lt="ordered array of button inputs">button inputs</dfn> for a gamepad such that there is a unique element in the axis array for each axis input and a unique element in the button array for each button input.
+        If the system enumerates axis and button inputs in a consistent order, then the methods SHOULD provide the inputs in that order.
+        Otherwise, the methods MAY use any consistent ordering.
+      </p>
+      <p>
+        The <a>user agent</a> MUST provide methods for retrieving <dfn data-lt="ordered array of minimum logical values">ordered arrays of minimum logical values</dfn> and <dfn data-lt="ordered array of maximum logical values">maximum logical values</dfn> for each gamepad input.
+        The ordering of these arrays MUST match the ordering of the <a>ordered array of axis inputs</a> and <a>ordered array of button inputs</a>.
+      </p>
+      <p>
+        The <a>user agent</a> MUST provide methods for retrieving <dfn data-lt="ordered array of logical axis input values">ordered arrays of logical axis input values</dfn> and <dfn data-lt="ordered array of logical button input values">button input values</dfn>.
+        These arrays MUST contain the most recent values received from the gamepad for each button and axis input.
+        The ordering of these arrays MUST match the ordering of the <a>ordered array of axis inputs</a> and <a>ordered array of button inputs</a>.
+      </p>


I'd suggest we delete these and just use Infra types. Also, it will avoid descriptors for things that happen algorithmically anyway.

Just a note, only add a data-lt= to dfns if you are creating an alias.

Like

<dfn data-lt="fruit of the gods">bananas</dfn> where the [=fruit of the gods=], and yet...

I've removed these definitions and rewritten the relevant part of the algorithm, please take a look

index.html

Replace <a>anchor tags</a> with [=definition links=] Add internal slots and getters for readonly attributes Add a Gamepad initializer algorithm Add HR-TIME clock resolution warning More Infra references and syntax Fix gamepaddisconnected algorithm Specify event targets Add gh-contributors

marcoscaceres

Wowser! This is so much better! Nice one @nondebug!

I'd be inclined for us to take this as is (with the suggestions) and we should just build on it.

index.html

marcoscaceres · 2021-07-08T06:36:17Z

index.html

+                      |now|.
+                      </li>
+                      <li>If |gamepad|'s [=relevant global object=] is a
+                      {{Window}} object, [=queue a global task=] on |gamepad|'s


Here, we might want to also do the fully active check (as we are checking the {{Window}} is still there, per #149).... we can come back to this tho.

I've added a fully active check so we won't try to fire events for non-fully-active Documents.

I removed the Window check since I think we'll implicitly make that check when trying to get the associated (or responsible) Document. If the global object isn't a Window then it won't have a Document. Is that correct?

index.html

marcoscaceres · 2021-07-08T06:48:15Z

index.html

+        <li>Let |gamepad:Gamepad| be the {{Gamepad}} representing the
+        unavailable device.
+        </li>
+        <li>Set |gamepad|.{{Gamepad/[[connected]]}} to `false`.


I think this should be done in the steps of the task (right before the event is fired), no? Otherwise, it would update somewhat randomly.

Agreed. We should update the gamepad state synchronously with firing the event to make sure the state changes are handled sequentially and predictably.

I think this order makes the most sense for gamepadconnected:

Create gamepad with gamepad.connected initialized to true

Add gamepad to navigator.[[gamepads]]

Dispatch gamepadconnected

And for gamepaddisconnected:

Set gamepad.connected to false

Dispatch gamepaddisconnected

Remove gamepad from navigator.[[gamepads]]

Updating in this order ensures the gamepad.connected state matches the stated reflected by the gamepadconnected or gamepaddisconnected event, and also ensures the item in the getGamepads() array at index gamepad.index is the same instance as the gamepad instance in the event.

marcoscaceres · 2021-07-08T06:50:14Z

index.html

-        object. Registration for and firing of the
-        <code>gamepaddisconnected</code> event MUST follow the usual behavior
-        of DOM Events. [[DOM]]
+        event, named {{gamepaddisconnected}}. The corresponding event MUST be


I think they "allowed to use" checks should only happen when the developer tries to use the API.

We can maybe have a global check that if the permission to use the API gets disabled, then just bring down everything... but that's probably overkill.

I've removed the "allowed to use" check here but there's still a reference in the gamepadconnected algorithm.

index.html

Changes the gamepadconnected/disconnected algorithms to update gamepad state synchronously with firing the event. Checks that the Document is fully active before firing events. Removes some unnecessary language.

marcoscaceres · 2021-07-09T00:15:38Z

https://www.w3.org/TR/2021/WD-gamepad-20210709/ 🎉

#151 Requested on the TAG review: w3ctag/design-reviews#662 (comment)

Add algorithms for getGamepads and events

baaa353

Fixes #114

marcoscaceres reviewed Jun 11, 2021

View reviewed changes

nondebug added 3 commits June 11, 2021 13:39

use infra types, fix slots, etc

c1e0084

use infra lists for slots

3e94e42

use words instead of < and > for comparisons

6b95b23

marcoscaceres reviewed Jun 15, 2021

View reviewed changes

index.html Outdated Show resolved Hide resolved

marcoscaceres reviewed Jun 15, 2021

View reviewed changes

index.html Outdated Show resolved Hide resolved

nondebug added 2 commits June 24, 2021 11:12

Tidy, syntax fixes

1007508

marcoscaceres approved these changes Jul 8, 2021

View reviewed changes

nondebug added 2 commits July 8, 2021 11:38

Update gamepad state on gamepad task source sequence

02f29b4

Changes the gamepadconnected/disconnected algorithms to update gamepad state synchronously with firing the event. Checks that the Document is fully active before firing events. Removes some unnecessary language.

Merge branch 'gh-pages' into algorithms

0abe48e

nondebug merged commit 390abc2 into gh-pages Jul 8, 2021

nondebug deleted the algorithms branch July 8, 2021 23:51

nondebug added a commit that referenced this pull request Sep 30, 2021

Add an explainer for PR #151

579dc98

#151 Requested on the TAG review: w3ctag/design-reviews#662 (comment)

himorin mentioned this pull request Aug 21, 2024

negative value for gamepad id immersive-web/webxr-gamepads-module#27

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add algorithms for getGamepads and events #151

Add algorithms for getGamepads and events #151

nondebug commented Jun 10, 2021 •

edited by pr-preview bot

Loading

marcoscaceres left a comment

marcoscaceres Jun 11, 2021

nondebug Jun 11, 2021

marcoscaceres Jun 11, 2021

marcoscaceres Jun 11, 2021

nondebug Jul 7, 2021

marcoscaceres left a comment

marcoscaceres Jul 8, 2021

nondebug Jul 8, 2021

marcoscaceres Jul 8, 2021

nondebug Jul 8, 2021

marcoscaceres Jul 8, 2021

nondebug Jul 8, 2021

marcoscaceres commented Jul 9, 2021

Add algorithms for getGamepads and events #151

Add algorithms for getGamepads and events #151

Conversation

nondebug commented Jun 10, 2021 • edited by pr-preview bot Loading

marcoscaceres left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoscaceres left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoscaceres commented Jul 9, 2021

nondebug commented Jun 10, 2021 •

edited by pr-preview bot

Loading