Public Member Functions | List of all members
rs2::depth_frame Class Reference

#include <rs_frame.hpp>

Inheritance diagram for rs2::depth_frame:
Inheritance graph

Public Member Functions

 depth_frame (const frame &f)
float get_distance (int x, int y) const
float get_units () const
- Public Member Functions inherited from rs2::video_frame
bool extract_target_dimensions (rs2_calib_target_type calib_type, float *target_dims, unsigned int target_dims_size) const
int get_bits_per_pixel () const
int get_bytes_per_pixel () const
int get_height () const
int get_stride_in_bytes () const
int get_width () const
 video_frame (const frame &f)
- Public Member Functions inherited from rs2::frame
frame apply_filter (filter_interface &filter)
template<class T >
as () const
 frame ()
 frame (rs2_frame *ref)
 frame (frame &&other) noexcept
 frame (const frame &other)
rs2_frameget () const
const voidget_data () const
const int get_data_size () const
rs2_metadata_type get_frame_metadata (rs2_frame_metadata_value frame_metadata) const
unsigned long long get_frame_number () const
rs2_timestamp_domain get_frame_timestamp_domain () const
stream_profile get_profile () const
rs2_sensorget_sensor ()
double get_timestamp () const
template<class T >
bool is () const
void keep ()
 operator bool () const
 operator rs2_frame * ()
frameoperator= (frame other)
bool supports_frame_metadata (rs2_frame_metadata_value frame_metadata) const
void swap (frame &other)
 ~frame ()

Additional Inherited Members

- Protected Member Functions inherited from rs2::frame
void add_ref () const
void reset ()

Detailed Description

Definition at line 807 of file rs_frame.hpp.

Constructor & Destructor Documentation

rs2::depth_frame::depth_frame ( const frame f)

Extends the video_frame class with additional depth related attributes and functions

[in]frame- existing frame instance

Definition at line 814 of file rs_frame.hpp.

Member Function Documentation

float rs2::depth_frame::get_distance ( int  x,
int  y 
) const

Provide the depth in meters at the given pixel

[in]intx - pixel's x coordinate.
[in]inty - pixel's y coordinate.
float - depth in metric units at given pixel

Definition at line 831 of file rs_frame.hpp.

float rs2::depth_frame::get_units ( ) const

Provide the scaling factor to use when converting from get_data() units to meters

float - depth, in meters, per 1 unit stored in the frame data

Definition at line 843 of file rs_frame.hpp.

The documentation for this class was generated from the following file:

Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Sat Apr 3 2021 02:51:28