Fold touchEvents from extensions.html into index.html #198

bradleyneedham · 2024-04-09T22:11:14Z

Partially Closes #165

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=1143942#c14)
Gecko (https://bugzilla.mozilla.org/show_bug.cgi?id=)

Standards positions:

Webkit (Gamepad multitouch API WebKit/standards-positions#110)
Gecko (Gamepad multitouch API mozilla/standards-positions#724)

Resources:

Explainer (https://github.com/bradleyneedham/gamepad/blob/multitouch-explainer/multitouch_explainer.md)
Gamepad Tests (https://github.com/bradleyneedham/gamepadtest)
Tag Review (Gamepad Extensions API touch input w3ctag/design-reviews#799)

Preview | Diff

bradleyneedham · 2024-04-09T22:56:28Z

I believe the failure of the tidy action is an indentation error on line 19 of .github/workflows/tidy.yml. The with needs to be even with the start of uses.
Current is:

line 18:             - uses:
line 19:             with:

Should be:

line 18:             - uses:
line 19:               with:

bradleyneedham · 2024-04-12T00:56:20Z

I am moving this from "Draft". Any help with spotting the reason for the validate failure is appreciated.

Also I think that newline: LF should be added to the tidyconfig.txt to prevent local runs of tidy on windows from adding all CRLF.

marcoscaceres · 2024-05-10T01:56:54Z

@bradleyneedham, sorry, I just need to double check if this is in scope of the Working Group. I seem to recall there was some concerns from some members around anything "touch" related, so just need to make sure it's all fine.

Shouldn't be too long!

marcoscaceres · 2024-05-10T02:57:11Z

index.html

@@ -2238,6 +2451,24 @@ <h2>
        </p>
      </div>
    </section>
+    <section>
+      <h3>
+        Glossary


This should really be part of a Model section... or wherever the general idea of gamepad is defined.

marcoscaceres · 2024-05-10T02:57:32Z

index.html

+        Glossary
+      </h3>
+      <p>
+        <dfn>touch surface</dfn> is a surface that can detect contact from a


Suggested change

<dfn>touch surface</dfn> is a surface that can detect contact from a

<dfn data-dfn-for="gamepad">touch surface</dfn> is a surface that can detect contact from a

marcoscaceres · 2024-05-10T02:58:08Z

index.html

+        users fingers and report where on the surface the contact is made.
+      </p>
+      <p>
+        <dfn>touch surface enumeration order</dfn> is an ordered listing of all


Suggested change

<dfn>touch surface enumeration order</dfn> is an ordered listing of all

<dfn data-dfn-for="gamepad">touch surface enumeration order</dfn> is an ordered listing of all

marcoscaceres · 2024-05-10T03:00:54Z

index.html

+        the surfaces in a |gamepad|.
+      </p>
+      <p>
+        <dfn>active touch point</dfn> is defined in the <a href=


Is there a concept we can maybe use from Pointer Events instead?

marcoscaceres · 2024-05-10T03:02:56Z

index.html

+            `null`
+          </td>
+          <td>
+            List of generated touch events.


Ok, so... are these really touch "events"? If we look at GamepadTouch, it's not an "Event" at all, so this is a misnomer.

They are more like snapshots of touch points.

marcoscaceres · 2024-05-10T03:03:48Z

index.html

@@ -460,6 +472,26 @@ <h2>
            </li>
          </ol>
        </dd>
+        <dt>
+          <dfn>touchEvents</dfn>


As above... I think it's incorrect to call these "touch events". They are activation points on the track pad at some specific moment in time.

marcoscaceres · 2024-05-10T03:08:24Z

index.html

+        <ol class="algorithm">
+          <li>Let |surfaceId:unsigned long| be 0.
+          </li>
+          <li>Remove any existing events from


This seems to assume the gamepad is a live object? I don't think this correct. Each gamepad object is just a snapshot in time.

index.html

marcoscaceres · 2024-06-13T23:11:27Z

index.html

+      </p>
+      <pre class="idl">
+        [Exposed=Window, SecureContext]
+        interface GamepadTouch {


Suggested change

interface GamepadTouch {

dictionary GamepadTouch {

marcoscaceres · 2024-06-13T23:12:02Z

index.html

+      <pre class="idl">
+        [Exposed=Window, SecureContext]
+        interface GamepadTouch {
+          readonly attribute unsigned long touchId;


Suggested change

readonly attribute unsigned long touchId;

unsigned long touchId;

marcoscaceres · 2024-06-13T23:12:14Z

index.html

+        [Exposed=Window, SecureContext]
+        interface GamepadTouch {
+          readonly attribute unsigned long touchId;
+          readonly attribute octet surfaceId;


Suggested change

readonly attribute octet surfaceId;

octet surfaceId;

marcoscaceres · 2024-06-13T23:12:41Z

index.html

+          readonly attribute Float32Array position;
+          readonly attribute Uint32Array? surfaceDimensions;


Suggested change

readonly attribute Float32Array position;

readonly attribute Uint32Array? surfaceDimensions;

Float32Array position;

Uint32Array surfaceDimensions;

marcoscaceres · 2024-06-13T23:16:17Z

index.html

@@ -153,6 +153,7 @@ <h2>
          readonly attribute GamepadMappingType mapping;
          readonly attribute FrozenArray&lt;double&gt; axes;
          readonly attribute FrozenArray&lt;GamepadButton&gt; buttons;
+          readonly attribute FrozenArray&lt;GamepadTouch&gt;? touchEvents;


Suggested change

readonly attribute FrozenArray<GamepadTouch>? touchEvents;

readonly attribute FrozenArray<GamepadTouch>? touches;

bradleyneedham · 2024-07-10T17:29:12Z

Just getting to back to this and wanted to verify our discussion at the last meeting.
In general is the following the suggested approach?

        dictionary GamepadTouch {
          unsigned long touchId;
          Float32Array position;
        };

        dictionary GamepadSurface {
          octet surfaceId;
          FrozenArray&lt;GamepadTouch&gt;? touches;
          Uint32Array surfaceDimensions;
        };

        interface Gamepad {
...
          readonly attribute FrozenArray&lt;GamepadSurface&gt;? surfaces;
...
        };

nondebug · 2024-07-11T19:46:26Z

If I remember correctly, we decided on maplike interfaces for the surfaceId -> GamepadSurface and touchId -> sequence<GamepadTouch> maps. I think it should look something like this:

        dictionary GamepadTouch {
          Float32Array position;
        };

        interface GamepadTouchMap {
          readonly maplike<unsigned long, sequence<GamepadTouch>>;
        };

        dictionary GamepadSurface {
          GamepadTouchMap touches;
          Uint32Array surfaceDimensions;
        };

        interface GamepadSurfaceMap {
          readonly maplike<octet, GamepadSurface>;
        };

        interface Gamepad {
...
          readonly attribute GamepadSurfaceMap surfaces;
...
        };

marcoscaceres · 2024-07-11T23:07:15Z

index.html

+            `null`
+          </td>
+          <td>
+            List of generated touch events.


Suggested change

List of generated touch events.

A [=list=] of touch that are represented as {{GamepadTouch}}s. The ordering is hardware or platform specific.

"touch surface enumeration order" "active touch point"

marcoscaceres · 2024-11-15T00:10:56Z

extensions.html

-          A list of all the {{GamepadHapticActuator}}s in the gamepad. The same object
-          MUST be returned until the user agent needs to return different
-          values (or values in a different order).
+          A list of all the {{GamepadHapticActuator}}s in the gamepad. The same


Note: this is an optimization... as you say, this can't be assured.

gabrielsanbrito · 2024-11-15T00:16:02Z

index.html

+            The {{Gamepad/touches}} getter steps are:
+          </p>
+          <ol>
+            <li>If [=this=].{{Gamepad/[[touches]]}} not `null` and not empty,


Suggested change

<li>If [=this=].{{Gamepad/[[touches]]}} not `null` and not empty,

<li>If [=this=].{{Gamepad/[[touches]]}} is not `null` and not empty,

marcoscaceres · 2024-11-15T00:19:33Z

index.html

+        </dt>
+        <dd>
+          <p>
+            A list of {{GamepadTouch}} events generated from all touch


Suggested change

A list of {{GamepadTouch}} events generated from all touch

A [=list=] of {{GamepadTouch}} generated from all touch

marcoscaceres · 2024-11-15T00:22:02Z

index.html

+            surfaces. If the device does not support touch events, MUST be set
+            to `null`.


Let's make it empty.

marcoscaceres · 2024-11-15T00:23:55Z

index.html

+            <li>If [=this=].{{Gamepad/[[touches]]}} not `null` and not empty,
+            return [=this=].{{Gamepad/[[touches]]}}.


Change this to return whatever is in the internal slot.

marcoscaceres · 2024-11-15T00:24:41Z

index.html

@@ -644,6 +678,102 @@ <h3>
            </ol>
          </li>
        </ol>
+        <p>
+          To <dfn>update touches</dfn> for |gamepad:Gamepad|, run the following


Suggested change

To <dfn>update touches</dfn> for |gamepad:Gamepad|, run the following

To <dfn>refresh touches</dfn> for |gamepad:Gamepad|, run the following

marcoscaceres · 2024-11-15T00:26:29Z

index.html

+          <li>Remove any existing events from
+          {{Gamepad}}.{{Gamepad/[[touches]]}}.


Suggested change

<li>Remove any existing events from

{{Gamepad}}.{{Gamepad/[[touches]]}}.

<li>[=List/empty=] {{Gamepad}}.{{Gamepad/[[touches]]}}.

marcoscaceres · 2024-11-15T00:28:14Z

index.html

+                  <li>Set |touchEvent|.{{GamepadTouch/surfaceDimensions}}[0] to
+                  the maximum X dimension on the touch surface in device units.
+                  </li>
+                  <li>Set |touchEvent|.{{GamepadTouch/surfaceDimensions}}[1] to
+                  the maximum Y dimension on the touch surface in device units.
+                  </li>


Use DOMRect/point terminology.

marcoscaceres · 2024-11-15T00:29:09Z

index.html

+              <li>Repeat the following steps for each active touch point
+              reported by the |gamepad| for the current touch surface.
+                <ol>
+                  <li>Let |nextTouchId:unsigned long| be the next available


You might want to increment the id on each loop.

marcoscaceres · 2024-11-15T00:31:12Z

index.html

+              <li>If the touch surface exposes maximum surface dimensions in
+              device units:
+                <ol>
+                  <li>Set |touchEvent|.{{GamepadTouch/surfaceDimensions}}[0] to


Note, move away from calling it "*Event". Call it |gameTouch|, and

Suggested change

<li>Set |touchEvent|.{{GamepadTouch/surfaceDimensions}}[0] to

<li>Let |gamepadTouch| be a newly created {{GamepadTouch}.</li>

<li>Set |gamepadTouch|.{{GamepadTouch/surfaceDimensions}}[0] to

marcoscaceres · 2024-11-15T00:43:09Z

index.html

+              </li>
+            </ol>
+          </li>
+          <li>Increment |surfaceId|


oops, increment twice

marcoscaceres · 2024-11-15T00:45:20Z

index.html

@@ -676,6 +806,9 @@ <h3>
              <li>Initialize |gamepad|.{{Gamepad/[[buttons]]}} to the result of
              [=initializing buttons=] for |gamepad|.
              </li>
+              <li>Initialize |gamepad|.{{Gamepad/[[touches]]}} to the result of
+              [=initializing touches=] for |gamepad|.


Instead, of putting the result at the end, let's just increment as we go but we need to make sure the this is locked thread safe.

gabrielsanbrito · 2024-11-15T00:45:56Z

index.html

+            <li>Maintaining the uniqueness of the id per origin to prevent
+            fingerprinting.
+            </li>
+          </ul>{{GamepadTouch/touchId}} SHOULD be set to a default value of 0


Instead of using 0 here, should we store a touchId counter in an internal slot somewhere? Maybe in the target Gamepad object?

marcoscaceres · 2024-11-15T00:46:10Z

index.html

@@ -884,6 +1017,18 @@ <h3>
          <li>Return |buttons|.
          </li>
        </ol>
+        <p>
+          To <dfn data-lt="initializing touches">initialize touches</dfn> for a


We problem don't need this initializer anymore, as the initial sequence is empty.

marcoscaceres · 2024-11-15T00:51:28Z

index.html

+          readonly attribute DOMPoint position;
+          readonly attribute DOMRect? surfaceDimensions;


Suggested change

readonly attribute DOMPoint position;

readonly attribute DOMRect? surfaceDimensions;

DOMPoint position;

DOMRect? surfaceDimensions;

marcoscaceres · 2024-11-15T00:51:40Z

index.html

+        input medium is no longer making contact with the touch device.
+      </p>
+      <pre class="idl" data-cite="geometry-1">
+        [Exposed=Window, SecureContext]


Suggested change

[Exposed=Window, SecureContext]

gabrielsanbrito · 2024-11-15T00:53:24Z

index.html

@@ -153,6 +153,7 @@ <h2>
          readonly attribute GamepadMappingType mapping;
          readonly attribute FrozenArray&lt;double&gt; axes;
          readonly attribute FrozenArray&lt;GamepadButton&gt; buttons;
+          readonly attribute FrozenArray&lt;GamepadTouch&gt;? touches;


nit: Remove since it won't be nullable?

Suggested change

readonly attribute FrozenArray<GamepadTouch>? touches;

readonly attribute FrozenArray<GamepadTouch> touches;

bradleyneedham force-pushed the issue-165-fold-touchEvents-into-main-spec branch from b756fd4 to 8ec7959 Compare April 12, 2024 00:18

bradleyneedham added 3 commits April 11, 2024 17:42

Move touchEvents from extensions to index

ceac3a5

Tidy run

b78201b

Replace CRLF with LF

a4649ca

bradleyneedham force-pushed the issue-165-fold-touchEvents-into-main-spec branch from 8ec7959 to a4649ca Compare April 12, 2024 00:42

bradleyneedham marked this pull request as ready for review April 12, 2024 00:58

marcoscaceres added the blocked label May 10, 2024

marcoscaceres reviewed May 10, 2024

View reviewed changes

index.html Show resolved Hide resolved

marcoscaceres reviewed Jun 13, 2024

View reviewed changes

Change touchEvents to touches

9421da4

marcoscaceres reviewed Jul 11, 2024

View reviewed changes

bradleyneedham force-pushed the issue-165-fold-touchEvents-into-main-spec branch from 926ef0f to 0d65b74 Compare September 23, 2024 17:05

Use DOMPoint and DOMRect

436b0c1

bradleyneedham force-pushed the issue-165-fold-touchEvents-into-main-spec branch from c3160a0 to 436b0c1 Compare November 14, 2024 19:48

bradleyneedham added 3 commits November 14, 2024 13:32

Correct xref, remove Glossary

eeaa1b2

Remove refs for "touch surface"

4ee147e

"touch surface enumeration order" "active touch point"

Run tidy

11ac046

marcoscaceres reviewed Nov 15, 2024

View reviewed changes

gabrielsanbrito reviewed Nov 15, 2024

View reviewed changes

marcoscaceres reviewed Nov 15, 2024

View reviewed changes

index.html

</li>

</ol>

</li>

<li>Increment |surfaceId|

Copy link

Member

marcoscaceres Nov 15, 2024

Choose a reason for hiding this comment

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

oops, increment twice

marcoscaceres reviewed Nov 15, 2024

View reviewed changes

gabrielsanbrito reviewed Nov 15, 2024

View reviewed changes

marcoscaceres reviewed Nov 15, 2024

View reviewed changes

gabrielsanbrito reviewed Nov 15, 2024

View reviewed changes

	<dfn>touch surface</dfn> is a surface that can detect contact from a
	<dfn data-dfn-for="gamepad">touch surface</dfn> is a surface that can detect contact from a

	<dfn>touch surface enumeration order</dfn> is an ordered listing of all
	<dfn data-dfn-for="gamepad">touch surface enumeration order</dfn> is an ordered listing of all

	readonly attribute unsigned long touchId;
	unsigned long touchId;

		readonly attribute Float32Array position;
		readonly attribute Uint32Array? surfaceDimensions;

	readonly attribute FrozenArray<GamepadTouch>? touchEvents;
	readonly attribute FrozenArray<GamepadTouch>? touches;

	List of generated touch events.
	A [=list=] of touch that are represented as {{GamepadTouch}}s. The ordering is hardware or platform specific.

	<li>If [=this=].{{Gamepad/[[touches]]}} not `null` and not empty,
	<li>If [=this=].{{Gamepad/[[touches]]}} is not `null` and not empty,

	A list of {{GamepadTouch}} events generated from all touch
	A [=list=] of {{GamepadTouch}} generated from all touch

		surfaces. If the device does not support touch events, MUST be set
		to `null`.

		<li>If [=this=].{{Gamepad/[[touches]]}} not `null` and not empty,
		return [=this=].{{Gamepad/[[touches]]}}.

	To <dfn>update touches</dfn> for \|gamepad:Gamepad\|, run the following
	To <dfn>refresh touches</dfn> for \|gamepad:Gamepad\|, run the following

		<li>Remove any existing events from
		{{Gamepad}}.{{Gamepad/[[touches]]}}.

	<li>Remove any existing events from
	{{Gamepad}}.{{Gamepad/[[touches]]}}.
	<li>[=List/empty=] {{Gamepad}}.{{Gamepad/[[touches]]}}.

	<li>Set \|touchEvent\|.{{GamepadTouch/surfaceDimensions}}[0] to
	<li>Let \|gamepadTouch\| be a newly created {{GamepadTouch}.</li>
	<li>Set \|gamepadTouch\|.{{GamepadTouch/surfaceDimensions}}[0] to

		readonly attribute DOMPoint position;
		readonly attribute DOMRect? surfaceDimensions;

Fold touchEvents from extensions.html into index.html #198

Are you sure you want to change the base?

Fold touchEvents from extensions.html into index.html #198

Conversation

bradleyneedham commented Apr 9, 2024 • edited by pr-preview bot Loading

bradleyneedham commented Apr 9, 2024 • edited Loading

bradleyneedham commented Apr 12, 2024

marcoscaceres commented May 10, 2024

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 May 10, 2024 • edited Loading

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 Jun 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradleyneedham commented Jul 10, 2024

nondebug commented Jul 11, 2024

marcoscaceres Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoscaceres Nov 15, 2024 • edited Loading

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 Nov 15, 2024 • edited Loading

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

Choose a reason for hiding this comment

bradleyneedham commented Apr 9, 2024 •

edited by pr-preview bot

Loading

bradleyneedham commented Apr 9, 2024 •

edited

Loading

marcoscaceres May 10, 2024 •

edited

Loading

marcoscaceres Jun 13, 2024 •

edited

Loading

marcoscaceres Jul 11, 2024 •

edited

Loading

marcoscaceres Nov 15, 2024 •

edited

Loading

marcoscaceres Nov 15, 2024 •

edited

Loading