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

#include <rs_processing.hpp>

Inheritance diagram for rs2::processing_block:
rs2::options rs2::asynchronous_syncer rs2::filter rs2::align rs2::colorizer rs2::decimation_filter rs2::depth_huffman_decoder rs2::disparity_transform rs2::gl::camera_renderer rs2::gl::pointcloud_renderer rs2::gl::uploader rs2::hdr_merge rs2::hole_filling_filter rs2::pointcloud rs2::rates_printer rs2::save_single_frameset rs2::save_to_ply rs2::sequence_id_filter rs2::spatial_filter rs2::temporal_filter rs2::threshold_filter rs2::units_transform rs2::y411_decoder rs2::yuy_decoder

Public Member Functions

template<class S >
void start (S on_frame)
 
template<class S >
S & operator>> (S &on_frame)
 
void invoke (frame f) const
 
 processing_block (std::shared_ptr< rs2_processing_block > block)
 
template<class S >
 processing_block (S processing_function)
 
 operator rs2_options * () const
 
rs2_processing_block * get () const
 
bool supports (rs2_camera_info info) const
 
const char * get_info (rs2_camera_info info) const
 
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_option > get_supported_options ()
 
options_list get_supported_option_values ()
 
options & operator= (const options &other)
 
 options (const options &other)
 
virtual ~options ()=default
 

Protected Member Functions

void register_simple_option (rs2_option option_id, option_range range)
 
- Protected Member Functions inherited from rs2::options
 options (rs2_options *o=nullptr)
 
template<class T >
options & operator= (const T &dev)
 

Protected Attributes

std::shared_ptr< rs2_processing_block > _block
 

Detailed Description

Define the processing block flow, inherit this class to generate your own processing_block. Please refer to the viewer class in examples.hpp for a detailed usage example.

Constructor & Destructor Documentation

◆ processing_block() [1/2]

rs2::processing_block::processing_block ( std::shared_ptr< rs2_processing_block >  block)
inline

constructor with already created low level processing block assigned.

Parameters
[in]block- low level rs2_processing_block created before.

◆ processing_block() [2/2]

template<class S >
rs2::processing_block::processing_block ( S  processing_function)
inline

constructor with callback function on_frame in rs2_frame_processor_callback structure assigned.

Parameters
[in]processing_function- function pointer of on_frame function in rs2_frame_processor_callback structure, which will be called back by invoke function .

Member Function Documentation

◆ get()

rs2_processing_block* rs2::processing_block::get ( ) const
inline

◆ get_info()

const char* rs2::processing_block::get_info ( rs2_camera_info  info) const
inline

Retrieve camera specific information, like versions of various internal components.

Parameters
[in]infocamera info type to retrieve
Returns
the requested camera info string, in a format specific to the processing_block model

◆ invoke()

void rs2::processing_block::invoke ( frame  f) const
inline

Ask processing block to process the frame

Parameters
[in]on_frameframe to be processed.

◆ operator rs2_options *()

rs2::processing_block::operator rs2_options * ( ) const
inline

◆ operator>>()

template<class S >
S& rs2::processing_block::operator>> ( S &  on_frame)
inline

Does the same thing as "start" function

Parameters
[in]on_frameaddress of callback function for noticing the frame to be processed is ready.
Returns
address of callback function.

◆ register_simple_option()

void rs2::processing_block::register_simple_option ( rs2_option  option_id,
option_range  range 
)
inlineprotected

◆ start()

template<class S >
void rs2::processing_block::start ( S  on_frame)
inline

Start the processing block with callback function on_frame to inform the application the frame is processed.

Parameters
[in]on_framecallback function for notifying the frame to be processed is ready.

◆ supports() [1/2]

bool rs2::options::supports
inline

check if particular option is supported

Parameters
[in]optionoption id to be checked
Returns
true if option is supported

◆ supports() [2/2]

bool rs2::processing_block::supports ( rs2_camera_info  info) const
inline

Check if a specific camera info field is supported.

Parameters
[in]infothe parameter to check for support
Returns
true if the parameter both exists and well-defined for the specific processing_block

Member Data Documentation

◆ _block

std::shared_ptr<rs2_processing_block> rs2::processing_block::_block
protected
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.14