Web/API/XRViewerPose/views

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

The read-only XRViewerPose property views returns an array which contains every XRView which must be rendered in order to fully represent the scene from the viewpoint defined by the viewer pose. For monoscopic devices, this array contains a single view.

Important: There is no guarantee that the number of views will remain constant over the lifetime of an XRSession. For each frame, you should always use the current length of this array rather than caching the value.

Stereo views require two views to render properly, with the left eye's view having its eye set to the string left and the right eye's view a value of right.

Syntax

let viewList = xrViewerPose.views;

Value

An array of XRView objects, one for each view available as part of the scene for the current viewer pose. This array's length may potentially vary over the lifetime of the XRSession (for example, if the viewer enables or disables stereo mode on their XR output device).

Examples

In this example—part of the code to render an XRFrame, getViewerPose() is called to get an XRViewerPose using the same reference space the code is using as its base reference space. If a valid pose is returned, the frame is rendered by clearing the backbuffer and then rendering each of the views in the pose; these are most likely the views for the left and right eyes.

let pose = frame.getViewerPose(xrReferenceSpace);

if (pose) {
  let glLayer = xrSession.renderState.baseLayer;

  gl.bindFrameBuffer(gl.FRAMEBUFFER, glLayer.framebuffer);
  gl.clearColor(0, 0, 0, 1);
  gl.clearDepth(1);
  gl.clear(gl.COLOR_BUFFER_BIT, gl.DEPTH_BUFFER_BIT);

  for (let view of pose.views) {
    let viewport = glLayer.getViewport(view);
    gl.viewport(viewport.x, viewport.y, viewport.width, viewport.height);
 
    /* render the scene for the eye view.eye */
  }
}

Passing each view to getViewport() returns the WebGL viewport to apply in order to cause the rendered output to be positioned correctly in the framebuffer for renderijng to the corresponding eye on the output device.

This code is derived from Drawing a frame in Movement, orientation, and motion: A WebXR example. You can see more context and see much more on that page.

Specifications

Specification	Status	Comment
WebXR Device APIThe definition of 'XRViewerPose.views' in that specification.	Working Draft	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`views`	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