Draft
This page is not complete.
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
var xrViewerPose = xrFrame.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 thatgetViewerPose()
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 | Status | Comment |
---|---|---|
WebXR Device API The definition of 'XRFrame.getViewerPose()' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getViewerPose() | 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
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.