DepthMediaFrame.MaxReliableDepth Property

Definition

Namespace:

Windows.Media.Capture.Frames

Gets a value that specifies the maximum reliable depth value for the camera that captured the depth frame.

public:
 property unsigned int MaxReliableDepth { unsigned int get(); };

uint32_t MaxReliableDepth();

public uint MaxReliableDepth { get; }

var uInt32 = depthMediaFrame.maxReliableDepth;

Public ReadOnly Property MaxReliableDepth As UInteger

Property Value

UInt32

unsigned int

uint32_t

A value that specifies the maximum reliable depth value for the camera that captured the depth frame.

Windows requirements

Device family	Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v4.0)

Remarks

A depth camera may not be able to reliably sense the depth for the full range of the UInt16 value that is used to express depth in a depth media frame. The value of MaxReliableDepth is set by the depth camera device to indicate the upper limit of values within the UInt16 range for which the device can reliably capture depth data. You can safely clamp depth pixel values greater than this value. The lower limit of reliable depth values is specified with the MinReliableDepth property. These properties are expressed in the same units as the individual depth pixel values. You can convert MaxReliableDepth to meters by multiplying it by the value of the DepthScaleInMeters property of the DepthFormat property of the DepthMediaFrame object.