Share via


IDepthFrame Interface

Represents a frame where each pixel represents the distance of the closest object seen by that pixel.

Syntax

interface IDepthFrame : public IUnknown

Members

IDepthFrame has the following members.

Methods

Name Description
AccessUnderlyingBuffer Gets a pointer to the depth frame data.
CopyFrameDataToArray Copies the depth frame data to an unsigned array.
get_DepthFrameSource Gets the source of the depth frame.
get_DepthMaxReliableDistance Gets the maximum reliable depth of the depth frame.
get_DepthMinReliableDistance Gets the minimum reliable depth of the depth frame.
get_FrameDescription Gets the description of the depth frame.
get_RelativeTime Gets the timestamp of the depth frame.

Remarks

The data for this frame is stored as 16-bit unsigned integers, where each value represents the distance in millimeters. The maximum depth distance is 8 meters, although reliability starts to degrade at around 4.5 meters. Developers can use the depth frame to build custom tracking algorithms in cases where the IBodyFrame isn’t enough.

Requirements

Header: kinect.h

Library: kinect20.lib