@driftengine/xr 3.61.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Drift Technologies
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+DriftEngine
+Copyright 2026 Drift Technologies
+
+This product includes software developed at Drift Technologies
+(https://github.com/drftrun/driftengine).
+
+Licensed under the Apache License, Version 2.0. Section 4(d) of that licence
+requires this NOTICE to be reproduced in any derivative work you distribute,
+in the source, the documentation, or a display generated by the work.

package/README.md

@@ -0,0 +1,106 @@
+# @driftengine/xr
+
+WebXR sessions, stereo views, controller input and hand joints, over both backends.
+
+**A package and not part of core**, so a game that never enters a session carries none of it. It
+supplies views to a camera; nothing in core reaches back for a session.
+
+```ts
+import { startLoop } from '@driftengine/core';
+import { aimCameraAtEye, enterXr, eyeViews, probeXrSupport } from '@driftengine/xr';
+
+// From a click. requestSession needs a user gesture and no wrapper can change that.
+const entered = await enterXr({ sources: { gl }, optionalFeatures: ['hand-tracking'] });
+if (!entered.ok) {
+  showTheUser(entered.reason);
+  return;
+}
+
+const { run } = entered;
+const stop = startLoop(
+  {
+    simulate: (dt, tick) => world.step(dt, tick),
+    render: (alpha, dt, wallDt, frame) => {
+      const pose = (frame as XrFrame).getViewerPose(run.referenceSpace);
+      if (pose === null) return; // Tracking lost. Draw nothing rather than draw it wrong.
+      for (const eye of eyeViews(pose, run.layer.baseLayer)) {
+        aimCameraAtEye(camera, eye);
+        renderer.setViewport(eye.viewport);
+        renderer.draw(scene, camera);
+      }
+    },
+  },
+  { frameSource: run.frameSource },
+);
+
+run.onEnd(stop);
+```
+
+## The camera is supplied, not configured
+
+`Camera` derives its view from yaw and pitch and its projection from `mat4.perspective`, and it
+cannot describe an XR eye. Its own note says why: _only a centred crop of a symmetric frustum is
+itself a symmetric frustum; an off-centre one is sheared, which `perspective` cannot produce._ A
+headset's eye projection is exactly that shear, off-axis by the distance from pupil to display
+centre.
+
+So `Camera.adoptView` takes the matrices the runtime computed. It recomputes the combined and
+inverse matrices, so culling, picking and the sky keep working, and it decomposes `position` and
+`forward` back out, so a listener placed at `camera.position` follows the head rather than staying
+where the last flat frame left it. It leaves `yaw`, `pitch` and `roll` alone, because a supplied
+rotation may be one no Euler triple describes.
+
+## The loop runs on the session's clock
+
+A session produces frames at whatever rate its display runs, through its own
+`requestAnimationFrame`, and the callback carries the frame every pose is read from. Hand
+`run.frameSource` to `startLoop` and the engine follows it. Outside a session the window drives, as
+it always did.
+
+## Nothing fails silently
+
+Every path that does not enter a session answers with a whole sentence, because a consumer whose
+button did nothing is owed the difference between a browser with no WebXR, a machine with no
+headset, a context that would not become XR compatible, and a reference space the runtime declined.
+Those are four different things to do next.
+
+`probeXrSupport` asks by **doing**. `isSessionSupported` is a promise about a mode and says nothing
+about whether a context can be made XR compatible, which is the step that actually fails: on a
+machine with no headset, `inline` reports supported, the session starts, the reference space is
+granted, and `makeXRCompatible` throws. Without it there is no base layer and therefore no frame at
+all.
+
+## Both backends
+
+`XRGPUBinding` with a projection layer where the runtime has one, `XRWebGLLayer` otherwise, chosen
+from what the session offers rather than from a preference. A WebGPU layer that fails to build falls
+through to WebGL2 and says so, because a game running on WebGPU in a browser whose WebXR is
+WebGL-only should enter a session rather than refuse.
+
+WebGPU in WebXR is experimental. In Chrome it is behind `--enable-experimental-web-platform-features`
+and its own note calls it available for developer testing on Windows and Android. This package does
+not ask a consumer to ship that flag; it uses the binding when a browser already offers one.
+
+## From a script
+
+`drift/xr` binds twelve capabilities: whether a session is presenting, where the head is, what each
+hand's trigger and grip are doing, where a named joint is, and whether a hand is pinching. **None of
+them is deterministic**, so a `@deterministic` system cannot ask where a head is, which is the
+property the annotation exists for. **None of them is a matrix**: drawing the two eyes is the host's,
+because the host owns the renderer.
+
+## What has been measured, and what has not
+
+The machine this was written on has no headset. `immersive-vr` reports false and `makeXRCompatible`
+throws, so no `XRFrame` can be produced there at all.
+
+- **Measured** by `npm run check:xr` against a real browser: capability detection, a real `inline`
+  session requested and ended, a real reference space, the WebGPU binding constructing under the
+  flag, and every refusal path.
+- **Measured** by the unit tests against a synthetic runtime: two views with different off-axis
+  projections, the camera adopting each, controller buttons and poses, twenty-five hand joints, and
+  a joint that stops being tracked keeping its last pose.
+- **Not measured**: a real immersive session, stereo on hardware, controller input from a device,
+  hand tracking, device performance, and the compositor's reprojection.
+
+That last line is an open row, unmeasured rather than claimed. Nothing here says otherwise.

package/dist/hands.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Twenty-five joints a hand, read into flat arrays.
+ *
+ * **The joint names are the specification's and their order is this file's**, fixed once as
+ * `HAND_JOINTS` so an index means the same thing in every frame, on every device and in a recording
+ * somebody kept. Reading them into a `Float32Array` rather than handing back objects is the same
+ * decision every other per-frame reader in this engine makes: a hand is twenty-five poses, twice,
+ * at ninety hertz, and an object per joint is four and a half thousand allocations a second on the
+ * device this arrangement exists for.
+ *
+ * **A joint that is not tracked is not zeroed**, and that is the interesting decision here. Hand
+ * tracking loses joints constantly, one at a time, as fingers occlude each other from the camera's
+ * view. Writing an identity matrix into an untracked joint would collapse that finger to the wrist
+ * for one frame and snap it back on the next, which reads as a violent twitch. So the last known
+ * pose stays, `tracked` says it is stale, and a consumer decides whether to hold, fade or hide.
+ * That is a policy a game owns, and this package refuses to make it for them.
+ */
+import type { XrFrame, XrInputSource } from './types.ts';
+/**
+ * Every joint WebXR defines, in the order this engine indexes them.
+ *
+ * Wrist first, then each finger from its base outward, which is the order the specification lists
+ * them in and the order a reader expects. **Never reordered**: an index is written into recordings
+ * and compared across runs, so moving one would change what a stored hand means.
+ */
+export declare const HAND_JOINTS: readonly ['wrist', 'thumb-metacarpal', 'thumb-phalanx-proximal', 'thumb-phalanx-distal', 'thumb-tip', 'index-finger-metacarpal', 'index-finger-phalanx-proximal', 'index-finger-phalanx-intermediate', 'index-finger-phalanx-distal', 'index-finger-tip', 'middle-finger-metacarpal', 'middle-finger-phalanx-proximal', 'middle-finger-phalanx-intermediate', 'middle-finger-phalanx-distal', 'middle-finger-tip', 'ring-finger-metacarpal', 'ring-finger-phalanx-proximal', 'ring-finger-phalanx-intermediate', 'ring-finger-phalanx-distal', 'ring-finger-tip', 'pinky-finger-metacarpal', 'pinky-finger-phalanx-proximal', 'pinky-finger-phalanx-intermediate', 'pinky-finger-phalanx-distal', 'pinky-finger-tip'];
+export type HandJoint = (typeof HAND_JOINTS)[number];
+export declare const JOINT_COUNT: 25;
+/** The index of a named joint, so a consumer never counts. */
+export declare const JOINT_INDEX: Readonly<Record<string, number>>;
+/**
+ * One hand's joints, allocated once and written into every frame.
+ *
+ * Sixteen floats a joint because a joint carries a full transform: a fingertip has an orientation
+ * as well as a position, and a consumer drawing a mesh needs both.
+ */
+export declare class HandSkeleton {
+    /** Row-major transforms, `JOINT_COUNT * 16`, in world space. */
+    readonly matrices: Float32Array<ArrayBuffer>;
+    /** Joint radii in metres, or 0 where the runtime offered none. */
+    readonly radii: Float32Array<ArrayBuffer>;
+    /** Whether each joint had a pose in the last frame that was read. */
+    readonly tracked: Uint8Array<ArrayBuffer>;
+    /** How many joints were tracked in that frame. Zero means the hand is not visible. */
+    trackedCount: number;
+    /** Whether anything at all was seen, which is what a consumer branches on before drawing. */
+    get visible(): boolean;
+    /**
+     * Forget everything, which is what a source going away means.
+     *
+     * Separate from a frame where every joint is merely untracked: a hand that has left has no last
+     * known pose worth holding, and a consumer that fades on loss needs the two told apart.
+     */
+    clear(): void;
+}
+/**
+ * Read one hand into a skeleton.
+ *
+ * Returns whether anything was tracked. `false` with the skeleton left holding its last poses is
+ * the ordinary case for a hand that has moved out of the cameras' view, and it is not an error.
+ */
+export declare function readHand(source: XrInputSource, frame: XrFrame, referenceSpace: unknown, into: HandSkeleton): boolean;
+/** A joint's position, read out of the flat storage without allocating. */
+export declare function jointPosition(skeleton: HandSkeleton, joint: HandJoint | number, out: Float32Array): boolean;

package/dist/hands.js

@@ -0,0 +1,134 @@
+/**
+ * Twenty-five joints a hand, read into flat arrays.
+ *
+ * **The joint names are the specification's and their order is this file's**, fixed once as
+ * `HAND_JOINTS` so an index means the same thing in every frame, on every device and in a recording
+ * somebody kept. Reading them into a `Float32Array` rather than handing back objects is the same
+ * decision every other per-frame reader in this engine makes: a hand is twenty-five poses, twice,
+ * at ninety hertz, and an object per joint is four and a half thousand allocations a second on the
+ * device this arrangement exists for.
+ *
+ * **A joint that is not tracked is not zeroed**, and that is the interesting decision here. Hand
+ * tracking loses joints constantly, one at a time, as fingers occlude each other from the camera's
+ * view. Writing an identity matrix into an untracked joint would collapse that finger to the wrist
+ * for one frame and snap it back on the next, which reads as a violent twitch. So the last known
+ * pose stays, `tracked` says it is stale, and a consumer decides whether to hold, fade or hide.
+ * That is a policy a game owns, and this package refuses to make it for them.
+ */
+/**
+ * Every joint WebXR defines, in the order this engine indexes them.
+ *
+ * Wrist first, then each finger from its base outward, which is the order the specification lists
+ * them in and the order a reader expects. **Never reordered**: an index is written into recordings
+ * and compared across runs, so moving one would change what a stored hand means.
+ */
+export const HAND_JOINTS = [
+    'wrist',
+    'thumb-metacarpal',
+    'thumb-phalanx-proximal',
+    'thumb-phalanx-distal',
+    'thumb-tip',
+    'index-finger-metacarpal',
+    'index-finger-phalanx-proximal',
+    'index-finger-phalanx-intermediate',
+    'index-finger-phalanx-distal',
+    'index-finger-tip',
+    'middle-finger-metacarpal',
+    'middle-finger-phalanx-proximal',
+    'middle-finger-phalanx-intermediate',
+    'middle-finger-phalanx-distal',
+    'middle-finger-tip',
+    'ring-finger-metacarpal',
+    'ring-finger-phalanx-proximal',
+    'ring-finger-phalanx-intermediate',
+    'ring-finger-phalanx-distal',
+    'ring-finger-tip',
+    'pinky-finger-metacarpal',
+    'pinky-finger-phalanx-proximal',
+    'pinky-finger-phalanx-intermediate',
+    'pinky-finger-phalanx-distal',
+    'pinky-finger-tip',
+];
+export const JOINT_COUNT = HAND_JOINTS.length;
+/** The index of a named joint, so a consumer never counts. */
+export const JOINT_INDEX = Object.freeze(Object.fromEntries(HAND_JOINTS.map((name, index) => [name, index])));
+/**
+ * One hand's joints, allocated once and written into every frame.
+ *
+ * Sixteen floats a joint because a joint carries a full transform: a fingertip has an orientation
+ * as well as a position, and a consumer drawing a mesh needs both.
+ */
+export class HandSkeleton {
+    /** Row-major transforms, `JOINT_COUNT * 16`, in world space. */
+    matrices = new Float32Array(JOINT_COUNT * 16);
+    /** Joint radii in metres, or 0 where the runtime offered none. */
+    radii = new Float32Array(JOINT_COUNT);
+    /** Whether each joint had a pose in the last frame that was read. */
+    tracked = new Uint8Array(JOINT_COUNT);
+    /** How many joints were tracked in that frame. Zero means the hand is not visible. */
+    trackedCount = 0;
+    /** Whether anything at all was seen, which is what a consumer branches on before drawing. */
+    get visible() {
+        return this.trackedCount > 0;
+    }
+    /**
+     * Forget everything, which is what a source going away means.
+     *
+     * Separate from a frame where every joint is merely untracked: a hand that has left has no last
+     * known pose worth holding, and a consumer that fades on loss needs the two told apart.
+     */
+    clear() {
+        this.matrices.fill(0);
+        this.radii.fill(0);
+        this.tracked.fill(0);
+        this.trackedCount = 0;
+    }
+}
+/**
+ * Read one hand into a skeleton.
+ *
+ * Returns whether anything was tracked. `false` with the skeleton left holding its last poses is
+ * the ordinary case for a hand that has moved out of the cameras' view, and it is not an error.
+ */
+export function readHand(source, frame, referenceSpace, into) {
+    const hand = source.hand;
+    if (hand === undefined || frame.getJointPose === undefined) {
+        into.trackedCount = 0;
+        into.tracked.fill(0);
+        return false;
+    }
+    let tracked = 0;
+    for (let i = 0; i < JOINT_COUNT; i++) {
+        const space = hand.get(HAND_JOINTS[i]);
+        const pose = space === undefined || space === null
+            ? null
+            : (frame.getJointPose(space, referenceSpace) ?? null);
+        if (pose === null) {
+            /*
+             * Left as it was. See the header: zeroing an occluded joint collapses that finger onto the
+             * wrist for one frame and snaps it back on the next, and a hand tracker loses joints
+             * constantly. The flag says the pose is stale; what to do about it is the consumer's.
+             */
+            into.tracked[i] = 0;
+            continue;
+        }
+        into.matrices.set(pose.transform.matrix, i * 16);
+        into.radii[i] = pose.radius ?? 0;
+        into.tracked[i] = 1;
+        tracked++;
+    }
+    into.trackedCount = tracked;
+    return tracked > 0;
+}
+/** A joint's position, read out of the flat storage without allocating. */
+export function jointPosition(skeleton, joint, out) {
+    const index = typeof joint === 'number' ? joint : (JOINT_INDEX[joint] ?? -1);
+    if (index < 0 || index >= JOINT_COUNT)
+        return false;
+    /* Column-major, as every matrix in this engine is, so the translation is elements 12 to 14. */
+    const at = index * 16;
+    out[0] = skeleton.matrices[at + 12];
+    out[1] = skeleton.matrices[at + 13];
+    out[2] = skeleton.matrices[at + 14];
+    return skeleton.tracked[index] === 1;
+}

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+/*! DriftEngine | Copyright 2026 Drift Technologies | Apache-2.0 | https://github.com/drftrun/driftengine */
+/**
+ * WebXR: sessions, stereo views, controller input and hand joints.
+ *
+ * **A package and not part of core**, so a game that never enters a session carries none of it.
+ * `size-gate.test.mjs` keeps that a measurement rather than an intention.
+ *
+ * **It supplies views to a camera and core never reaches back for a session.** That is the whole
+ * shape of the dependency: `Camera.adoptView` lives in core because the camera is core's, and the
+ * reason a camera cannot derive an XR eye's matrices is written beside it. Everything about
+ * sessions, layers, poses and hands is here.
+ *
+ * ## What is measured, and what is written down instead
+ *
+ * A real immersive session has never been run against this code. The machine it was written on has
+ * no headset: `immersive-vr` reports false, and `makeXRCompatible` throws, so no `XRFrame` can be
+ * produced there at all. What that machine does reach is asserted by `scripts/xr-check.mjs`, and
+ * everything past the first frame is exercised against a synthetic `XRSystem` in the unit tests.
+ *
+ * So **stereo on hardware, controller input, hand tracking, device performance and the compositor's
+ * reprojection are unmeasured**, and are tracked as such rather than claimed. Nothing
+ * here says otherwise.
+ */
+export type { XrFrame, XrGamepad, XrHand, XrInputSource, XrJointPose, XrMode, XrRigidTransform, XrSession, XrSystem, XrView, XrViewerPose, XrViewport, XrWebGlLayer, } from './types.ts';
+export type { XrCompatibleContext, XrSupport } from './support.ts';
+export { bestMode, probeXrSupport } from './support.ts';
+export type { LayerBackend, LayerSources, XrLayer } from './layers.ts';
+export { chooseLayer } from './layers.ts';
+export type { EnterXrOptions, EnterXrResult, XrRun } from './session.ts';
+export { enterXr } from './session.ts';
+export type { EyeView } from './views.ts';
+export { aimCameraAtEye, eyeViews } from './views.ts';
+export type { ControllerState, Handedness, XrButton } from './input.ts';
+export { XR_BUTTON, buttonPressed, buttonValue, controllerFor, readController, readControllers, } from './input.ts';
+export type { HandJoint } from './hands.ts';
+export { HAND_JOINTS, HandSkeleton, JOINT_COUNT, JOINT_INDEX, jointPosition, readHand, } from './hands.ts';

package/dist/index.js

@@ -0,0 +1,29 @@
+/*! DriftEngine | Copyright 2026 Drift Technologies | Apache-2.0 | https://github.com/drftrun/driftengine */
+/**
+ * WebXR: sessions, stereo views, controller input and hand joints.
+ *
+ * **A package and not part of core**, so a game that never enters a session carries none of it.
+ * `size-gate.test.mjs` keeps that a measurement rather than an intention.
+ *
+ * **It supplies views to a camera and core never reaches back for a session.** That is the whole
+ * shape of the dependency: `Camera.adoptView` lives in core because the camera is core's, and the
+ * reason a camera cannot derive an XR eye's matrices is written beside it. Everything about
+ * sessions, layers, poses and hands is here.
+ *
+ * ## What is measured, and what is written down instead
+ *
+ * A real immersive session has never been run against this code. The machine it was written on has
+ * no headset: `immersive-vr` reports false, and `makeXRCompatible` throws, so no `XRFrame` can be
+ * produced there at all. What that machine does reach is asserted by `scripts/xr-check.mjs`, and
+ * everything past the first frame is exercised against a synthetic `XRSystem` in the unit tests.
+ *
+ * So **stereo on hardware, controller input, hand tracking, device performance and the compositor's
+ * reprojection are unmeasured**, and are tracked as such rather than claimed. Nothing
+ * here says otherwise.
+ */
+export { bestMode, probeXrSupport } from './support.js';
+export { chooseLayer } from './layers.js';
+export { enterXr } from './session.js';
+export { aimCameraAtEye, eyeViews } from './views.js';
+export { XR_BUTTON, buttonPressed, buttonValue, controllerFor, readController, readControllers, } from './input.js';
+export { HAND_JOINTS, HandSkeleton, JOINT_COUNT, JOINT_INDEX, jointPosition, readHand, } from './hands.js';

package/dist/input.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Controllers, read the way the rest of this engine reads input.
+ *
+ * **A controller is a gamepad with a pose, and the specification says so**: an `XRInputSource`
+ * carries an ordinary `Gamepad` whose button order is fixed by the WebXR gamepad profile. So the
+ * buttons are named here rather than indexed at every call site, and the names are the profile's
+ * rather than any device's marketing: `trigger`, `squeeze`, `touchpad`, `thumbstick`.
+ *
+ * **What is deliberately absent is a binding layer.** This engine has `ActionMap`, and a second one
+ * that only XR could reach would be a second answer to what a button means. A consumer maps a
+ * trigger to an action the same way they map a key, which is why this reads state and never
+ * dispatches an intent.
+ *
+ * **Nothing here is deterministic and none of it belongs in a fixed step.** A controller pose
+ * arrives with a frame, from a device, at a rate the runtime chooses. `drift/ui` already settled
+ * that a pointer position is `input.read` and outside `DETERMINISTIC_EFFECTS`, and a hand is the
+ * same kind of fact.
+ */
+import type { XrFrame, XrInputSource, XrSession } from './types.ts';
+/** Which hand, as WebXR reports it. `none` is a source with no handedness, like a gaze pointer. */
+export type Handedness = 'left' | 'right' | 'none';
+/**
+ * The buttons the WebXR gamepad profile fixes, in its order.
+ *
+ * Indexes and not a guess: the profile pins 0 to the trigger and 1 to the squeeze for every device
+ * that reports `xr-standard`, which is what makes reading them by name safe. A device offering
+ * fewer buttons simply has none at the higher indexes, which reads as zero rather than as an error.
+ */
+export declare const XR_BUTTON: {
+    readonly trigger: 0;
+    readonly squeeze: 1;
+    readonly touchpad: 2;
+    readonly thumbstick: 3;
+};
+export type XrButton = keyof typeof XR_BUTTON;
+/** One controller, as much of it as this engine reads. */
+export interface ControllerState {
+    readonly handedness: Handedness;
+    /** How the source is aimed: `tracked-pointer`, `gaze` or `screen`. */
+    readonly targetRayMode: string;
+    /** Whether a pose was available this frame. False while a controller is out of view. */
+    readonly tracked: boolean;
+    /** The grip transform's matrix, valid only while `tracked`. */
+    readonly gripMatrix: Float32Array | null;
+    /** Where the source is aiming, which is not where it is held. */
+    readonly rayMatrix: Float32Array | null;
+    /** Analogue values in the profile's order, and zero for a button the device does not have. */
+    readonly buttons: readonly number[];
+    readonly pressed: readonly boolean[];
+    readonly axes: readonly number[];
+}
+/**
+ * Read every input source a session currently reports.
+ *
+ * `out` is filled and returned, so a frame loop allocates nothing after the first call. Sources
+ * come and go as controllers wake and sleep, which is why the list is read from the session every
+ * frame rather than cached at `inputsourceschange`: the event exists for a consumer that wants to
+ * react, and this is the polling half.
+ */
+export declare function readControllers(session: XrSession, frame: XrFrame, referenceSpace: unknown, out?: ControllerState[]): ControllerState[];
+export declare function readController(source: XrInputSource, frame: XrFrame, referenceSpace: unknown): ControllerState;
+/** One named button's analogue value, or zero where the device has no such button. */
+export declare function buttonValue(state: ControllerState, button: XrButton): number;
+/** Whether a named button is pressed, false where the device has no such button. */
+export declare function buttonPressed(state: ControllerState, button: XrButton): boolean;
+/** The first source for a hand, or null. Two sources may share a handedness and rarely do. */
+export declare function controllerFor(states: readonly ControllerState[], handedness: Handedness): ControllerState | null;