Skip to content

[WebXR] Add hapticActuators to gamepad on XRInputSource #69613

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.

Sign up for GitHub

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

Merged
typescript-bot merged 5 commits into from
Jun 28, 2024
Merged

[WebXR] Add hapticActuators to gamepad on XRInputSource #69613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c8ac4dd
Add hapticActuators to gamepad on XRInputSource
sorskoot May 15, 2024
779917b
Fix test + return promise
sorskoot May 15, 2024
89e796d
Add docs
sorskoot May 15, 2024
155c251
Fix formatting
sorskoot May 15, 2024
a8a5a21
Added extra remark about the hapticActuators being added
sorskoot Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions types/webxr/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,28 @@ interface XRInputSource {

declare abstract class XRInputSource implements XRInputSource {}

/**
* This Gamepad API interface represents hardware in the controller designed to provide haptic feedback to the user (if available), most commonly vibration hardware.
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/GamepadHapticActuator)
*/
interface GamepadHapticActuator {
/**
* The pulse() method of the GamepadHapticActuator interface makes the hardware pulse at a certain intensity for a specified duration.
* @remarks Repeated calls to pulse() override the previous calls if they are still ongoing.
* @param value A double representing the intensity of the pulse. This can vary depending on the hardware type, but generally takes a value between 0.0 (no intensity) and 1.0 (full intensity).
* @param duration A double representing the duration of the pulse, in milliseconds.
* @returns A promise that resolves with a value of true when the pulse has successfully completed.
*
* @remarks This feature should be documented in the Gamepad API, but it is not yet implemented in any browser thus missing there. However, it is commonly used in WebXR applications and causes issues for people if omitted.
*/
pulse(value: number, duration: number): Promise<boolean>;
}

interface Gamepad {
readonly hapticActuators: readonly GamepadHapticActuator[];
Copy link
Contributor

@RaananW RaananW May 15, 2024

Choose a reason for hiding this comment

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

This should probably be optional? This is not supported by all implementations. And the initial value (per specs) is undefined

}

/**
* Represents a list of XRInputSources. It is used in favor of a frozen array type when the contents
* of the list are expected to change over time, such as with the XRSession inputSources attribute.
Expand Down
4 changes: 4 additions & 0 deletions types/webxr/webxr-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ function assertNever(value: never) {
throw new Error("Can't test instance of XRSession");
}

if (session.inputSources[0].gamepad?.hapticActuators) {
session.inputSources[0].gamepad.hapticActuators[0].pulse(0.5, 100);
}

const button = root?.querySelector("button");
button?.addEventListener("beforexrselect", (evt: XRSessionEvent) => {
console.assert(evt.session === session);
Expand Down