Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Public Member Functions | List of all members
rs2::depth_sensor Class Reference

#include <rs_sensor.hpp>

Inheritance diagram for rs2::depth_sensor:
rs2::sensor rs2::options rs2::depth_stereo_sensor

Public Member Functions

 depth_sensor (sensor s)
 
float get_depth_scale () const
 
 operator bool () const
 
 depth_sensor (std::shared_ptr< rs2_sensor > dev)
 
- Public Member Functions inherited from rs2::sensor
void open (const stream_profile &profile) const
 
bool supports (rs2_camera_info info) const
 
const char * get_info (rs2_camera_info info) const
 
void open (const std::vector< stream_profile > &profiles) const
 
void close () const
 
template<class T >
void start (T callback) const
 
void stop () const
 
template<class T >
void set_notifications_callback (T callback) const
 
std::vector< stream_profileget_stream_profiles () const
 
std::vector< stream_profileget_active_streams () const
 
std::vector< filterget_recommended_filters () const
 
sensoroperator= (const std::shared_ptr< rs2_sensor > other)
 
sensoroperator= (const sensor &other)
 
 sensor ()
 
 operator bool () const
 
const std::shared_ptr< rs2_sensor > & get () const
 
template<class T >
bool is () const
 
template<class T >
as () const
 
 sensor (std::shared_ptr< rs2_sensor > dev)
 
 operator std::shared_ptr< rs2_sensor > ()
 
bool supports (rs2_option option) const
 
- Public Member Functions inherited from rs2::options
bool supports (rs2_option option) const
 
const char * get_option_description (rs2_option option) const
 
const char * get_option_name (rs2_option option) const
 
const char * get_option_value_description (rs2_option option, float val) const
 
float get_option (rs2_option option) const
 
option_value get_option_value (rs2_option option_id) const
 
option_range get_option_range (rs2_option option) const
 
void set_option (rs2_option option, float value) const
 
void set_option_value (option_value const &value) const
 
bool is_option_read_only (rs2_option option) const
 
void on_options_changed (std::function< void(const options_list &) > callback) const
 
std::vector< rs2_optionget_supported_options ()
 
options_list get_supported_option_values ()
 
optionsoperator= (const options &other)
 
 options (const options &other)
 
virtual ~options ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from rs2::options
 options (rs2_options *o=nullptr)
 
template<class T >
optionsoperator= (const T &dev)
 
- Protected Attributes inherited from rs2::sensor
friend context
 
friend device_list
 
friend device
 
friend device_base
 
friend roi_sensor
 
std::shared_ptr< rs2_sensor_sensor
 

Constructor & Destructor Documentation

◆ depth_sensor() [1/2]

rs2::depth_sensor::depth_sensor ( sensor  s)
inline

◆ depth_sensor() [2/2]

rs2::depth_sensor::depth_sensor ( std::shared_ptr< rs2_sensor dev)
inlineexplicit

Member Function Documentation

◆ get_depth_scale()

float rs2::depth_sensor::get_depth_scale ( ) const
inline

Retrieves mapping between the units of the depth image and meters

Returns
depth in meters corresponding to a depth value of 1

◆ operator bool()

rs2::depth_sensor::operator bool ( ) const
inline

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