XRDepthInformation
WebXR Device API
WebXR Device API
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:
Instance properties
- XRDepthInformation.height
- : Contains the height of the depth buffer (number of rows).
- XRDepthInformation.normDepthBufferFromNormView
- : An XRRigidTransform that 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's
widthandheightto obtain the absolute depth-buffer coordinates. - XRDepthInformation.rawValueToMeters
- : Contains the scale factor by which the raw depth values must be multiplied in order to get the depths in meters.
- XRDepthInformation.width
- : Contains the width of the depth buffer (number of columns).
Instance methods
None.
Examples
See XRCPUDepthInformation and XRWebGLDepthInformation for code examples.
Specifications
Browser compatibility
See also
- XRCPUDepthInformation
- XRWebGLDepthInformation
- XRFrame.getDepthInformation()