XRDepthInformation

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.height Read only

Contains the height of the depth buffer (number of rows).

XRDepthInformation.normDepthBufferFromNormView Read only

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 width and height to obtain the absolute depth-buffer coordinates.

XRDepthInformation.rawValueToMeters Read only

Contains the scale factor by which the raw depth values must be multiplied in order to get the depths in meters.

XRDepthInformation.width Read only

Contains the width of the depth buffer (number of columns).

Methods

None.

Examples

See XRCPUDepthInformation and XRWebGLDepthInformation for code examples.

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
XRDepthInformation	90	90	No	No	76	No	No	90	No	No	No	No
height	90	90	No	No	76	No	No	90	No	No	No	No
normDepthBufferFromNormView	90	90	No	No	76	No	No	90	No	No	No	No
rawValueToMeters	90	90	No	No	76	No	No	90	No	No	No	No
width	90	90	No	No	76	No	No	90	No	No	No	No

See also

• XRCPUDepthInformation
• XRWebGLDepthInformation
• XRFrame.getDepthInformation()