XRFrame: getPose() 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 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

js
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
WebXR Device API
# dom-xrframe-getpose

Browser compatibility

BCD tables only load in the browser