XRDepthInformation
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The XRDepthInformation interface contains information about the distance from the user's device to the real-world geometry in the user's environment.
This interface is the parent of:
XRCPUDepthInformation-
Depth information from the CPU (returned by
XRFrame.getDepthInformation()). XRWebGLDepthInformation-
Depth information from WebGL (returned by
XRWebGLBinding.getDepthInformation()).
You will usually interact with these child interfaces. However, XRDepthInformation provides some useful properties that are inherited:
Properties
XRDepthInformation.heightRead only-
Contains the height of the depth buffer (number of rows).
XRDepthInformation.normDepthBufferFromNormViewRead only-
An
XRRigidTransformthat needs to be applied when indexing into the depth buffer. The transformation that the matrix represents changes the coordinate system from normalized view coordinates to normalized depth-buffer coordinates that can then be scaled by depth buffer'swidthandheightto obtain the absolute depth-buffer coordinates. XRDepthInformation.rawValueToMetersRead only-
Contains the scale factor by which the raw depth values must be multiplied in order to get the depths in meters.
XRDepthInformation.widthRead only-
Contains the width of the depth buffer (number of columns).
Methods
None.
Examples
See XRCPUDepthInformation and XRWebGLDepthInformation for code examples.
Specifications
| Specification |
|---|
| WebXR Depth Sensing Module # xrdepthinformation |
Browser compatibility
BCD tables only load in the browser