XRFrame: getViewerPose() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
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
XRReferenceSpaceobject 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
InvalidStateErrorDOMException-
Thrown if
getViewerPose()was not called within the context of a callback to a session'sXRSession.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
| Specification |
|---|
| WebXR Device API # dom-xrframe-getviewerpose |
Browser compatibility
Loading…