VRDisplay.getPose()

Deprecated
This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. Avoid using it and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The getPose() method of the VRDisplay interface returns a VRPose object defining the future predicted pose of the VRDisplay as it will be when the current frame is actually presented.

This method is deprecated — instead, you should use VRDisplay.getFrameData(), which also provides a VRPose object.

Syntax

var myPose = vrDisplayInstance.getPose();

Parameters

None.

Return value

A VRPose object.

Examples

Once we have a reference to a VRDisplay object, we can retrieve the VRPose representing the current pose of the display.

if(navigator.getVRDisplays) {
  console.log('WebVR 1.1 supported');
  // Then get the displays attached to the computer
  navigator.getVRDisplays().then(function(displays) {
    // If a display is available, use it to present the scene
    if(displays.length > 0) {
      vrDisplay = displays[0];
      console.log('Display found');
          // Return the current VRPose object for the display
          var pose = vrDisplay.getPose();
          ...
    }
  });
}

It is however recommended that you use the non-deprecated pose property of the VRFrameData object (retrieved via VRDisplay.getFrameData()) to retrieve the current pose for each frame before it is submitted to the display to be presented. This happens on each iteration of the rendering loop for your app, so you can be sure the pose data is current.

Specifications

Specification Status Comment
WebVR 1.1
The definition of 'getPose()' in that specification.		 Editor's Draft Initial definition

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support[1] (Yes) 55 (55)[2] No support No support No support
Feature Android Edge Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android Samsung Internet for GearVR
Basic support No support No support 55.0 (55) No support No support No support (Yes)[3] (Yes)
 

[1] API Available on all platforms behind a flag, but currently only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays() is invoked).

[2] Currently only Windows support is enabled by default. Mac support is available in Firefox Nightly.

[3] Currently supported only by Google Daydream.

See also

Document Tags and Contributors

Tags: 
 Contributors to this page: chrisdavidmills, abbycar
 Last updated by: chrisdavidmills,