XRDepthInformation: height property

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.

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

The read-only height property of the XRDepthInformation interface contains the height of the depth buffer (number of rows).

Value

An unsigned long integer.

Examples

Use XRFrame.getDepthInformation() (CPU) or XRWebGLBinding.getDepthInformation() (WebGL) to obtain depth information. The returned objects will contain the height of the depth buffer, which you can use for further calculations.

js
const smallerDepthDimension = Math.min(depthInfo.width, depthInfo.height);
const largerDepthDimension = Math.max(depthInfo.width, depthInfo.height);

Specifications

Specification
WebXR Depth Sensing Module
# dom-xrdepthinformation-height

Browser compatibility

BCD tables only load in the browser