Draft This page is not complete.
Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The updateRenderState()
method of the XRSession
interface of WebXR API schedules changes to be applied to the active render state prior to rendering of the next frame.
Syntax
xrSession.updateRenderState(newState)
Parameters
newState
- An object conforming to the
XRRenderStateInit
dictionary specifying the properties of the session'srenderState
to update before rendering the next frame.
The specified object may have any combination of the following fields.
baseLayer
Optional- An
XRWebGLLayer
object from which the WebXR compositor will obtain imagery. This isnull
by default. depthFar
Optional- A floating-point value specifying the distance in meters from the viewer to the far clip plane, which is a plane parallel to the display surface beyond which no further rendering will occur. All rendering will take place between the distances specified by
depthNear
anddepthFar
. This is 1000 meters (1 kilometer) by default. depthNear
Optional- A floating-point value indicating the distance in meters from the viewer to a plane parallel to the display surface to be the near clip plane. No part of the scene on the viewer's side of this plane will be rendered. This is 0.1 meters (10 centimeters) by default.
inlineVerticalFieldOfView
Optional- A floating-point value indicating the default field of view, in radians, to be used when computing the projection matrix for an
inline
XRSession
. The projection matrix calculation also takes into account the output canvas's aspect ratio. This property must not be specified for immersive sessions, so the value isnull
by default for immersive sessions. The default value is otherwise π * 0.5 (half of the value of pi).
Return value
None.
Exceptions
This method may throw any of the following exceptions. These are true exceptions, since this method does not return a promise.
InvalidStateError
- This may occur for one of the following reasons:
- The
XRSession
has already ended, so you cannot change its render state. - The
baseLayer
specified innewState
was created by anXRSession
other than the one on whichupdateRenderState()
was called. - The
inlineVerticalFieldOfView
property was set, but the session is immersive and therefore does not allow this property to be used.
- The
Examples
This example creates a WebGL context that is compatible with an immersive XR device and then uses it to create an XRWebGLLayer
. updateRenderState()
is then called to associate the new XRWebGLLayer
.
function onXRSessionStarted(xrSession) {
let glCanvas = document.createElement("canvas");
let gl = glCanvas.getContext("webgl", { xrCompatible: true });
loadWebGLResources();
xrSession.updateRenderState({ baseLayer: new XRWebGLLayer(xrSession, gl) });
}
Specifications
Specification | Status | Comment |
---|---|---|
WebXR Device APIThe definition of 'XRSession.updateRenderState()' in that specification. | Working Draft | Initial definition. |
Browser compatibility
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
updateRenderState()
|
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
See also
XRSession.updateRenderState() by Mozilla Contributors is licensed under CC-BY-SA 2.5.