XRCPUDepthInformation.getDepthInMeters()

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

The getDepthInMeters() method of the XRCPUDepthInformation interface returns the depth in meters at (x, y) in normalized view coordinates (origin in the top left corner).

Syntax

getDepthInMeters(x, y)

Parameters

x

X coordinate (origin at the left, grows to the right).

y

Y coordinate (origin at the top, grows downward).

Return value

None (undefined).

Exceptions

  • A RangeError is thrown if x or y are greater than 1.0 or less than 0.0.

Examples

const distance = depthInfo.getDepthInMeters(x, y);

Specifications

Specification
WebXR Depth Sensing Module
# dom-xrcpudepthinformation-getdepthinmeters

Browser compatibility

BCD tables only load in the browser