#include <rs_frame.hpp>
◆ 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 |
◆ begin()
◆ end()
◆ first()
Retrieve back the first frame of specific stream type, if no frame found, error will be thrown
- Parameters
-
[in] | rs2_stream | s - frame to be retrieved from this stream type. |
- Returns
- frame - first found frame with s stream type.
◆ first_or_default()
Retrieve back the first frame of specific stream type, if no frame found, return the default one(frame instance)
- Parameters
-
[in] | rs2_stream | s - frame to be retrieved from this stream type. |
- Returns
- frame - first found frame with s stream type.
◆ foreach()
template<class T >
void rs2::frameset::foreach |
( |
T |
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()
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()
Retrieve back the first depth framee, if no frame found, return the default one(frame instance)
- Returns
- depth_frame - first found depth frame.
◆ 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
-
- Returns
- video_frame - first found infrared frame.
◆ 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:
- /builddir/build/BUILD/librealsense-2.15.0/include/librealsense2/hpp/rs_frame.hpp