#include <rs_processing.hpp>

Public Member Functions
frame	allocate_composite_frame (std::vector< frame > frames) const

frame	allocate_motion_frame (const stream_profile &profile, const frame &original, rs2_extension frame_type=RS2_EXTENSION_MOTION_FRAME) const

frame	allocate_points (const stream_profile &profile, const frame &original) const

frame	allocate_video_frame (const stream_profile &profile, const frame &original, int new_bpp=0, int new_width=0, int new_height=0, int new_stride=0, rs2_extension frame_type=RS2_EXTENSION_VIDEO_FRAME) const

void	frame_ready (frame result) const

Public Attributes
rs2_source *	_source

Private Member Functions
	frame_source (rs2_source *source)

	frame_source (const frame_source &)=delete

Friends
template<class T >
class	frame_processor_callback

Detailed Description

The source used to generate frames, which is usually done by the low level driver for each sensor. frame_source is one of the parameters of processing_block's callback function, which can be used to re-generate the frame and via frame_ready invoke another callback function to notify application frame is ready. Please refer to "video_processing_thread" code snippet in rs-measure.cpp for a detailed usage example.

Definition at line 18 of file rs_processing.hpp.

Constructor & Destructor Documentation

rs2::frame_source::frame_source ( rs2_source * source )

inlineprivate

Definition at line 112 of file rs_processing.hpp.

rs2::frame_source::frame_source ( const frame_source & )

privatedelete

Member Function Documentation

frame rs2::frame_source::allocate_composite_frame ( std::vector< frame > frames ) const

inline

Allocate composite frame with given params

Parameters

[in] frames Frame vecotor used to create composite frame, the size of composite frame will be the same as vector size.

Returns: The allocated composite frame

Definition at line 82 of file rs_processing.hpp.

frame rs2::frame_source::allocate_motion_frame	(	const stream_profile &	profile,
		const frame &	original,
		rs2_extension	frame_type = `RS2_EXTENSION_MOTION_FRAME`
	)		const

inline

Allocate a new motion frame with given params

Parameters

[in]	profile	Stream profile going to allocate.
[in]	original	Original frame.
[in]	frame_type	Which frame type are going to create.

Returns: The allocated frame

Definition at line 56 of file rs_processing.hpp.

frame rs2::frame_source::allocate_points	(	const stream_profile &	profile,
		const frame &	original
	)		const

inline

Definition at line 67 of file rs_processing.hpp.

frame rs2::frame_source::allocate_video_frame	(	const stream_profile &	profile,
		const frame &	original,
		int	new_bpp = `0`,
		int	new_width = `0`,
		int	new_height = `0`,
		int	new_stride = `0`,
		rs2_extension	frame_type = `RS2_EXTENSION_VIDEO_FRAME`
	)		const

inline

Allocate a new video frame with given params

Parameters

[in]	profile	Stream profile going to allocate.
[in]	original	Original frame, if new_bpp, new_width, new_height or new_stride is zero, newly created frame will base on original frame's metadata to allocate new frame. If frame_type is RS2_EXTENSION_DEPTH_FRAME, the original of the returned frame will be set to it.
[in]	new_bpp	Frame bit per pixel to create.
[in]	new_width	Frame width to create.
[in]	new_height	Frame height to create.
[in]	new_stride	Frame stride to create.
[in]	frame_type	Which frame type are going to create.

Returns: The allocated frame

Definition at line 33 of file rs_processing.hpp.

void rs2::frame_source::frame_ready ( frame result ) const

inline

Invoke the callback funtion informing the frame is ready.

Parameters

[in] frames frame to send to callback function.

Definition at line 99 of file rs_processing.hpp.

Friends And Related Function Documentation

template<class T >

friend class frame_processor_callback

friend

Definition at line 110 of file rs_processing.hpp.

Member Data Documentation

rs2_source* rs2::frame_source::_source

Definition at line 107 of file rs_processing.hpp.

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

rs_processing.hpp

Public Member Functions

Public Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation