XRSession.renderState

Secure context

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

The read-only renderState property of an XRSession object indicates the returns a XRRenderState object describing how the user's environment which should be rendered. The information provided covers the minimum and maximum distance at which to render objects, the vertical field of view to use when rendering the in the inline session mode, and the XRWebGLLayer to render into for inline composition.

While this property is read only, you can call the XRSession method updateRenderState() to make changes.

Syntax

var xrRenderState = XRSession.renderState;

Value

An XRRenderState object describing how to render the scene.

Specifications

Specification Status Comment
WebXR Device API
The definition of 'XRSession.renderState' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser