The getDepthInformation()
method of the XRWebGLBinding
interface returns an XRWebGLDepthInformation
object containing WebGL depth information.
Syntax
getDepthInformation(view)
Parameters
-
view
-
An XRView
object obtained from a viewer pose.
Return value
Exceptions
NotSupportedError
DOMException
-
Thrown if "depth-sensing"
is not in the list of enabled features for this XRSession
.
InvalidStateError
DOMException
-
Thrown if the XRFrame
is not active nor animated. Obtaining depth information is only valid within the requestAnimationFrame()
callback.
InvalidStateError
DOMException
-
Thrown if the session's depthUsage
is not "gpu-optimized"
.
Examples
const canvasElement = document.querySelector(".output-canvas");
const gl = canvasElement.getContext("webgl");
await gl.makeXRCompatible();
const session = navigator.xr.requestSession("immersive-ar", {
requiredFeatures: ["depth-sensing"],
depthSensing: {
usagePreference: ["gpu-optimized"],
formatPreference: ["luminance-alpha"],
},
});
const glBinding = new XRWebGLBinding(session, gl);
function rafCallback(time, frame) {
session.requestAnimationFrame(rafCallback);
const pose = frame.getViewerPose(referenceSpace);
if (pose) {
for (const view of pose.views) {
const depthInformation = glBinding.getDepthInformation(view);
if (depthInformation) {
}
}
}
}
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
getDepthInformation |
90 |
90 |
No |
No |
76 |
No |
No |
90 |
No |
64 |
No |
15.0 |
See also