XRCPUDepthInformation

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The XRCPUDepthInformation interface contains depth information from the CPU (returned by XRFrame.getDepthInformation()).

This interface inherits properties from its parent, XRDepthInformation.

Properties

XRCPUDepthInformation.data Read only

An ArrayBuffer containing depth-buffer information in raw format.

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

XRCPUDepthInformation.getDepthInMeters()

Returns the depth in meters at (x, y) in normalized view coordinates.

Examples

Specifications

Specification
WebXR Depth Sensing Module (WebXR Depth Sensing)
# xr-cpu-depth-info-section

Browser compatibility

BCD tables only load in the browser

See also