#include <rs_frame.hpp>

Inheritance diagram for rs2::frameset:

Classes
class	iterator

Public Member Functions
iterator	begin () const

iterator	end () const

frame	first (rs2_stream s, rs2_format f=RS2_FORMAT_ANY) const

frame	first_or_default (rs2_stream s, rs2_format f=RS2_FORMAT_ANY) const

template<class T >
void	foreach_rs (T action) const

	frameset ()

	frameset (const frame &f)

video_frame	get_color_frame () const

depth_frame	get_depth_frame () const

video_frame	get_fisheye_frame (const size_t index=0) const

video_frame	get_infrared_frame (const size_t index=0) const

pose_frame	get_pose_frame (const size_t index=0) const

frame	operator[] (size_t index) const

size_t	size () const

Public Member Functions inherited from rs2::frame
frame	apply_filter (filter_interface &filter)

template<class T >
T	as () const

	frame ()

	frame (rs2_frame *ref)

	frame (frame &&other) noexcept

	frame (const frame &other)

rs2_frame *	get () const

const void *	get_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_sensor *	get_sensor ()

double	get_timestamp () const

template<class T >
bool	is () const

void	keep ()

	operator bool () const

	operator rs2_frame * ()

frame &	operator= (frame other)

bool	supports_frame_metadata (rs2_frame_metadata_value frame_metadata) const

void	swap (frame &other)

	~frame ()

Private Attributes
size_t	_size

Additional Inherited Members
Protected Member Functions inherited from rs2::frame
void	add_ref () const

void	reset ()

Detailed Description

Definition at line 943 of file rs_frame.hpp.

Constructor & Destructor Documentation

rs2::frameset::frameset ( )

inline

Extends the frame class with additional frameset related attributes and functions

Definition at line 949 of file rs_frame.hpp.

rs2::frameset::frameset ( const frame & f )

inline

Extends the frame class with additional frameset related attributes and functions

Parameters

[in] frame - existing frame instance

Definition at line 954 of file rs_frame.hpp.

Member Function Documentation

iterator rs2::frameset::begin ( ) const

inline

Definition at line 1151 of file rs_frame.hpp.

iterator rs2::frameset::end ( ) const

inline

Definition at line 1152 of file rs_frame.hpp.

frame rs2::frameset::first	(	rs2_stream	s,
		rs2_format	f = `RS2_FORMAT_ANY`
	)		const

inline

Retrieve the first frame of a specific stream type and optionally with a specific format. If no frame is found, an error will be thrown.

Parameters

[in]	rs2_stream	s - frame to be retrieved from this stream type.
[in]	rs2_format	f - frame to be retrieved from this format type.

Returns: frame - first found frame with s stream type.

Definition at line 995 of file rs_frame.hpp.

frame rs2::frameset::first_or_default	(	rs2_stream	s,
		rs2_format	f = `RS2_FORMAT_ANY`
	)		const

inline

Retrieve the first frame of a specific stream and optionally with a specific format. If no frame is found, return an empty frame instance.

Parameters

[in]	rs2_stream	s - frame to be retrieved from this stream type.
[in]	rs2_format	f - frame to be retrieved from this format type.

Returns: frame - first found frame with s stream type.

Definition at line 978 of file rs_frame.hpp.

template<class T >

void rs2::frameset::foreach_rs ( T action ) const

inline

Template function, extract internal frame handles from the frameset and invoke the action function

Parameters

[in] action - instance with () operator implemented will be invoke after frame extraction.

Definition at line 1107 of file rs_frame.hpp.

video_frame rs2::frameset::get_color_frame ( ) const

inline

Retrieve the first color frame, if no frame is found, search for the color frame from IR stream. If one still can't be found, return an empty frame instance.

Returns: video_frame - first found color frame.

Definition at line 1015 of file rs_frame.hpp.

depth_frame rs2::frameset::get_depth_frame ( ) const

inline

Retrieve the first depth frame, if no frame is found, return an empty frame instance.

Returns: depth_frame - first found depth frame.

Definition at line 1006 of file rs_frame.hpp.

video_frame rs2::frameset::get_fisheye_frame ( const size_t index = 0 ) const

inline

Retrieve the fisheye monochrome video frame

Parameters

[in] size_t index

Returns: video_frame - the fisheye frame denoted by index.

Definition at line 1054 of file rs_frame.hpp.

video_frame rs2::frameset::get_infrared_frame ( const size_t index = 0 ) const

inline

Retrieve the first infrared frame, if no frame is found, return an empty frame instance.

Parameters

[in] size_t index

Returns: video_frame - first found infrared frame.

Definition at line 1032 of file rs_frame.hpp.

pose_frame rs2::frameset::get_pose_frame ( const size_t index = 0 ) const

inline

Retrieve the pose frame

Parameters

[in] size_t index

Returns: pose_frame - the sensor's positional data

Definition at line 1076 of file rs_frame.hpp.

frame rs2::frameset::operator[] ( size_t index ) const

inline

Bracket operator retrieves back the frame from frameset using arrary notation

Parameters

[in] index - index of array to retrieve data back.

Returns: frame - retrieved frame.

Definition at line 1124 of file rs_frame.hpp.

size_t rs2::frameset::size ( ) const

inline

Return the size of the frameset

Returns: size_t - frameset size.

Definition at line 1097 of file rs_frame.hpp.

Member Data Documentation

size_t rs2::frameset::_size

private

Definition at line 1154 of file rs_frame.hpp.

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

rs_frame.hpp

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation