1. Web
  2. Web APIs
  3. XRCPUDepthInformation
  4. getDepthInMeters()

XRCPUDepthInformation: getDepthInMeters() method

Limited availability

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

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

js
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

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

Specifications

Specification
WebXR Depth Sensing Module
# dom-xrcpudepthinformation-getdepthinmeters

Browser compatibility

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.

View this page on GitHub • Report a problem with this content