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

#include <rs_frame.hpp>

Inheritance diagram for rs2::frameset:
rs2::frame

Classes

class  iterator
 

Public Member Functions

 frameset ()
 
 frameset (const frame &f)
 
frame first_or_default (rs2_stream s, rs2_format f=RS2_FORMAT_ANY) const
 
frame first (rs2_stream s, rs2_format f=RS2_FORMAT_ANY) const
 
depth_frame get_depth_frame () const
 
video_frame get_color_frame () const
 
video_frame get_infrared_frame (const size_t index=0) const
 
video_frame get_fisheye_frame (const size_t index=0) const
 
pose_frame get_pose_frame (const size_t index=0) const
 
size_t size () const
 
template<class T >
void foreach (T action) const
 
frame operator[] (size_t index) const
 
iterator begin () const
 
iterator end () const
 
- Public Member Functions inherited from rs2::frame
 frame ()
 
 frame (rs2_frame *ref)
 
 frame (frame &&other) noexcept
 
frameoperator= (frame other)
 
 frame (const frame &other)
 
void swap (frame &other)
 
 ~frame ()
 
void keep ()
 
 operator bool () const
 
double get_timestamp () const
 
rs2_timestamp_domain get_frame_timestamp_domain () const
 
rs2_metadata_type get_frame_metadata (rs2_frame_metadata_value frame_metadata) const
 
bool supports_frame_metadata (rs2_frame_metadata_value frame_metadata) const
 
unsigned long long get_frame_number () const
 
const void * get_data () const
 
stream_profile get_profile () const
 
template<class T >
bool is () const
 
template<class T >
as () const
 
rs2_frameget () const
 
 operator rs2_frame * ()
 
frame apply_filter (filter_interface &filter)
 

Additional Inherited Members

- Protected Member Functions inherited from rs2::frame
void add_ref () const
 
void reset ()
 

Constructor & Destructor Documentation

◆ frameset() [1/2]

rs2::frameset::frameset ( )
inline

Inherit frame class with additional frameset related attributs/functions

◆ frameset() [2/2]

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

Inherit frame class with additional frameset related attributs/functions

Parameters
[in]frame- existing frame instance

Member Function Documentation

◆ begin()

iterator rs2::frameset::begin ( ) const
inline

◆ end()

iterator rs2::frameset::end ( ) const
inline

◆ first()

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

Retrieve back the first frame of specific stream type, if no frame found, error will be thrown

Parameters
[in]rs2_streams - frame to be retrieved from this stream type.
[in]rs2_formatf - frame to be retrieved from this format type.
Returns
frame - first found frame with s stream type.

◆ first_or_default()

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

Retrieve back the first frame of specific stream and format types, if no frame found, return the default one(frame instance)

Parameters
[in]rs2_streams - frame to be retrieved from this stream type.
[in]rs2_formatf - frame to be retrieved from this format type.
Returns
frame - first found frame with s stream type.

◆ foreach()

template<class T >
void rs2::frameset::foreach ( action) const
inline

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

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

◆ get_color_frame()

video_frame rs2::frameset::get_color_frame ( ) const
inline

Retrieve back the first color frame, if no frame found, search the color frame from IR stream. If still can't find, return the default one(frame instance)

Returns
video_frame - first found color frame.

◆ get_depth_frame()

depth_frame rs2::frameset::get_depth_frame ( ) const
inline

Retrieve back the first depth frame, if no frame found, return the default one(frame instance)

Returns
depth_frame - first found depth frame.

◆ get_fisheye_frame()

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

Retrieve the fisheye monochrome video frame

Parameters
[in]size_tindex
Returns
video_frame - the fisheye frame denoted by index.

◆ get_infrared_frame()

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

Retrieve back the first infrared frame, return the default one(frame instance)

Parameters
[in]size_tindex
Returns
video_frame - first found infrared frame.

◆ get_pose_frame()

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

Retrieve the pose frame

Parameters
[in]size_tindex
Returns
pose_frame - the sensor's positional data

◆ operator[]()

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.

◆ size()

size_t rs2::frameset::size ( ) const
inline

Return the size of the frameset

Returns
size_t - frameset size.

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