XRFrame.getPose()

Draft

This page is not complete.

Secure context

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

The XRFrame method getPose() returns the relative position and orientation—the pose—of one XRSpace to that of another space. With this, you can observe the motion of objects relative to each other and to fixed locations throughout the scene.

For example, to get the position of a controller relative to the viewer's head, you would compare the controller's gripSpace to the XRReferenceSpace of type viewer.

Syntax

var xrPose = xrFrame.getPose(space, baseSpace);

Parameters

space
An XRSpace specifying the space for which to obtain an XRPose describing the item's position and orientation.
baseSpace
An XRSpace to use as the base or origin for the purposes of computing the relative position and orientation.

Return value

An XRPose object specifying the position and orientation, relative to the XRSpace indicated by baseSpace.

Specifications

Specification Status Comment
WebXR Device API
The definition of 'XRFrame.getPose()' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser