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:
Inheritance graph
[legend]

Public Member Functions

rs2_processing_blockget () const
 
const char * get_info (rs2_camera_info info) const
 
void invoke (frame f) const
 
 operator rs2_options * () const
 
template<class S >
S & operator>> (S &on_frame)
 
 processing_block (std::shared_ptr< rs2_processing_block > block)
 
template<class S >
 processing_block (S processing_function)
 
template<class S >
void start (S on_frame)
 
bool supports (rs2_camera_info info) const
 
- Public Member Functions inherited from rs2::options
float get_option (rs2_option option) const
 
const char * get_option_description (rs2_option option) const
 
const char * get_option_name (rs2_option option) const
 
option_range get_option_range (rs2_option option) const
 
const char * get_option_value_description (rs2_option option, float val) const
 
std::vector< rs2_optionget_supported_options ()
 
bool is_option_read_only (rs2_option option) const
 
optionsoperator= (const options &other)
 
 options (const options &other)
 
void set_option (rs2_option option, float value) const
 
bool supports (rs2_option option) const
 
virtual ~options ()=default
 

Protected Member Functions

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

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.

Definition at line 233 of file rs_processing.hpp.

Constructor & Destructor Documentation

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.

Definition at line 281 of file rs_processing.hpp.

template<class S >
rs2::processing_block::processing_block ( 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 .

Definition at line 292 of file rs_processing.hpp.

Member Function Documentation

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

Definition at line 303 of file rs_processing.hpp.

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

Definition at line 323 of file rs_processing.hpp.

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

Ask processing block to process the frame

Parameters
[in]on_frameframe to be processed.

Definition at line 267 of file rs_processing.hpp.

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

Definition at line 302 of file rs_processing.hpp.

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.

Definition at line 257 of file rs_processing.hpp.

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

Definition at line 331 of file rs_processing.hpp.

template<class S >
void rs2::processing_block::start ( 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.

Definition at line 244 of file rs_processing.hpp.

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

Definition at line 310 of file rs_processing.hpp.

Member Data Documentation

std::shared_ptr<rs2_processing_block> rs2::processing_block::_block
protected

Definition at line 337 of file rs_processing.hpp.


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


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