XRCPUDepthInformation

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

XRDepthInformation XRCPUDepthInformation

This interface inherits properties from its parent, XRDepthInformation.

Instance properties

XRCPUDepthInformation.data Read only Experimental

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).

Instance methods

XRCPUDepthInformation.getDepthInMeters() Experimental

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

Examples

Specifications

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

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
XRCPUDepthInformation
Experimental
data
Experimental
getDepthInMeters
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.
See implementation notes.

See also