Draft
This page is not complete.
Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The XRRenderState
interface of the WebXR Device API contains configurable values which affect how the imagery generated by an XRSession
gets composited. These properties include the range of distances from the viewer within which content should be rendered, the vertical field of view (for inline presentations), and a reference to the XRWebGLLayer
being used as the target for rendering the scene prior to it being presented on the XR device's display or displays.
When you apply changes using the XRSession
method updateRenderState()
, the specified changes take effect after the current animation frame has completed, but before the next one begins.
Properties
The followiing properties are available on XRRenderState
objects.
baseLayer
Read only- The
XRWebGLLayer
from which the browser's compositing system obtains the image for the XR session. depthFar
Read only- The distance, in meters, of the far clip plane from the viewer. The far clip plane is the plane which is parallel to the display beyond which rendering of the scene no longer takes place. This, essentially, specifies the maximum distance the user can see.
depthNear
Read only- The distance, in meters, of the near clip plane from the viewer. The near clip plane is the plane, parallel to the display, at which rendering of the scene begins. Any closer to the viewer than this, and no portions of the scene are drawn.
inlineVerticalFieldOfView
Read only- The default vertical field of view, defined in radians, to use when the session is in
inline
mode.null
for all immersive sessions.
Specifications
Specification | Status | Comment |
---|---|---|
WebXR Device API The definition of 'XRRenderState' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
No compatibility data found. Please contribute data for "api.XRRenderState" (depth: 1) to the MDN compatibility data repository.