XRFrame.getViewerPose()

The getViewerPose() method, a member of the XRFrame interface, returns a XRViewerPose object which describes the viewer's pose (position and orientation) relative to the specified reference space.

See the getPose() method for a way to calculate a pose that represents the difference between two spaces.

Syntax

getViewerPose(referenceSpace)

Parameters

referenceSpace

An XRReferenceSpace object specifying the space to use as the reference point or base for the computation of the viewer's current pose.

Return value

A XRViewerPose describing the viewer's position and orientation relative to the specified reference space.

Exceptions

InvalidStateError

A DOMException indicating that getViewerPose() was not called within the context of a callback to a session's XRSession.requestAnimationFrame().

Examples

In this callback function for requestAnimationFrame(), the XRViewerPose describing the viewer's viewpoint on the world is obtained by calling getViewerPose() on the XRFrame passed into the callback.

viewerPose = xrFrame.getViewerPose(xrReferenceSpace);

if (viewerPose) {
  /* render the pose's views */
}

To see a complete example, take a look at Movement, orientation, and motion.

Specifications

Browser compatibility