Web/API/XRInputSourceEvent/frame

Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The read-only XRInputSourceEvent property frame specifies an XRFrame object representing the event frame during which a WebXR user input occurred. This may thus be an event which occurred in the past rather than a current or impending event.

Syntax

let inputFrame = xrInputSourceEvent.frame;

Value

An XRFrame indicating the event frame at which the user input event described by the object took place.

Usage notes

The event frame does not correspond to a visual frame as is delivered to the frame rendering callback function (see Rendering and the WebXR frame rendering callback for details on the callback). Instead, the XRFrame specified by the frame property is simply a method to provide access to the getPose() method, which you can use to get the relative positions of the objects in the scene at the time the event occurred.

However, since the event frame isn't an animation frame, there is no viewer pose available to represent the viewer's current point of view; the results of calling getViewerPose() will be an XRViewerPose with an empty views list.

Examples

This code shows a handler for the selectstart event which gets the target ray's pose from the frame, mapping the pose representing the ray (event.inputSource.targetRaySpace) to the overall reference space myRefSpace.

Then, if the result isn't null, the target ray pose's transform is passed into a function called myCheckAndHandleHit() to see if the ray was pointing at anything when the select was triggered.

xrSession.onselectstart = event => {
  let targetRayPose = event.frame.getPose(event.inputSource.targetRaySpace,
                            myRefSpace);
  if (targetRayPose) {
    checkAndHandleHit(targetRayPose.transform);
  }
};

Specifications

Specification	Status	Comment
WebXR Device APIThe definition of 'XRInputSourceEvent.frame' in that specification.	Working Draft	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`frame`	Chrome Full support 79	Edge Full support 79	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android No support No	Chrome Android Full support 79	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support 11.2

Legend

Full support: Full support
No support: No support

XRInputSourceEvent.frame by Mozilla Contributors is licensed under CC-BY-SA 2.5.