web api interface
XRFrame
Secure contextLimited availability
A WebXR Device API XRFrame object is passed into the requestAnimationFrame() callback function and provides access to the information needed in order to render a single frame of animation for an XRSession describing a VR or AR scene. Events which communicate the tracking state of objects also provide an XRFrame reference as part of their structure.
In addition to providing a reference to the XRSession for which this frame is to be rendered, the getViewerPose() method is provided to obtain the XRViewerPose describing the viewer’s position and orientation in space, and getPose() can be used to create an XRPose describing the relative position of one XRSpace relative to another.
Instance properties
sessionRead only Experimental- : The
XRSessionthat for which thisXRFramedescribes the tracking details for all objects. The information about a specific object can be obtained by calling one of the methods on the object.
- : The
trackedAnchorsRead only Experimental- : An
XRAnchorSetcontaining all anchors still tracked in the frame.
- : An
Instance methods
createAnchor()ExperimentalfillJointRadii()Experimental- : Populates a
Float32Arraywith radii for a list of hand joint spaces. Returnstrueif successful for all spaces.
- : Populates a
fillPoses()Experimental- : Populates a
Float32Arraywith the matrices of the poses, relative to a given base space. Returnstrueif all spaces have a valid pose.
- : Populates a
getDepthInformation()Experimental- : Returns an
XRCPUDepthInformationobject containing CPU depth information for the frame.
- : Returns an
getHitTestResults()Experimental- : Returns an array of
XRHitTestResultobjects containing hit test results for a givenXRHitTestSource.
- : Returns an array of
getHitTestResultsForTransientInput()Experimental- : Returns an array of
XRTransientInputHitTestResultobjects containing hit test results for a givenXRTransientInputHitTestSource.
- : Returns an array of
getJointPose()Experimental- : Returns an
XRJointPoseobject providing the pose of a hand joint (seeXRHand) relative to a given base space.
- : Returns an
getLightEstimate()Experimental- : Returns an
XRLightEstimateobject containing estimated lighting values for anXRLightProbe.
- : Returns an
getPose()ExperimentalgetViewerPose()Experimental- : Returns an
XRViewerPosedescribing the viewer’s position and orientation in a givenXRReferenceSpace.
- : Returns an
Specifications
SpecificationsStandards references are available on the canonical MDN page.
Browser compatibility
Browser compatibilityCompatibility data is available on the canonical MDN page.