Definition at line 735 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.


Public Member Functions | |
| points () | |
| Extends the frame class with additional point cloud related attributes and functions. More... | |
| points (const frame &f) | |
| Extends the frame class with additional point cloud related attributes and functions. More... | |
| const vertex * | get_vertices () const |
| Retrieve the vertices of the point cloud. More... | |
| void | export_to_ply (const std::string &fname, video_frame texture) |
| Export the point cloud to a PLY file. More... | |
| const texture_coordinate * | get_texture_coordinates () const |
| Retrieve the texture coordinates (uv map) for the point cloud. More... | |
| size_t | size () const |
| points () | |
| Extends the frame class with additional point cloud related attributes and functions. More... | |
| points (const frame &f) | |
| Extends the frame class with additional point cloud related attributes and functions. More... | |
| const vertex * | get_vertices () const |
| Retrieve the vertices of the point cloud. More... | |
| void | export_to_ply (const std::string &fname, video_frame texture) |
| Export the point cloud to a PLY file. More... | |
| const texture_coordinate * | get_texture_coordinates () const |
| Retrieve the texture coordinates (uv map) for the point cloud. More... | |
| size_t | size () const |
| void | swap (frame &other) |
| Swap the internal frame handle with the one in parameter. More... | |
| void | swap (frame &other) |
| Swap the internal frame handle with the one in parameter. More... | |
| void | keep () |
| keep the frame, otherwise if no refernce to the frame, the frame will be released. More... | |
| void | keep () |
| keep the frame, otherwise if no refernce to the frame, the frame will be released. More... | |
| operator bool () const | |
| Parenthesis operator check if internal frame handle is valid. More... | |
| operator bool () const | |
| Parenthesis operator check if internal frame handle is valid. More... | |
| rs2_sensor * | get_sensor () |
| rs2_sensor * | get_sensor () |
| double | get_timestamp () const |
| retrieve the time at which the frame was captured During the frame's lifetime it receives timestamps both at the device and host levels. More... | |
| double | get_timestamp () const |
| retrieve the time at which the frame was captured During the frame's lifetime it receives timestamps both at the device and host levels. More... | |
| rs2_timestamp_domain | get_frame_timestamp_domain () const |
| retrieve the timestamp domain More... | |
| rs2_timestamp_domain | get_frame_timestamp_domain () const |
| retrieve the timestamp domain More... | |
| rs2_metadata_type | get_frame_metadata (rs2_frame_metadata_value frame_metadata) const |
| retrieve the current value of a single frame_metadata More... | |
| rs2_metadata_type | get_frame_metadata (rs2_frame_metadata_value frame_metadata) const |
| retrieve the current value of a single frame_metadata More... | |
| bool | supports_frame_metadata (rs2_frame_metadata_value frame_metadata) const |
| determine if the device allows a specific metadata to be queried More... | |
| bool | supports_frame_metadata (rs2_frame_metadata_value frame_metadata) const |
| determine if the device allows a specific metadata to be queried More... | |
| unsigned long long | get_frame_number () const |
| retrieve frame number (from frame handle) More... | |
| unsigned long long | get_frame_number () const |
| retrieve frame number (from frame handle) More... | |
| const int | get_data_size () const |
| retrieve data size from frame handle More... | |
| const int | get_data_size () const |
| retrieve data size from frame handle More... | |
| const void * | get_data () const |
| retrieve data from frame handle More... | |
| const void * | get_data () const |
| retrieve data from frame handle More... | |
| stream_profile | get_profile () const |
| retrieve stream profile from frame handle More... | |
| stream_profile | get_profile () const |
| retrieve stream profile from frame handle More... | |
| template<class T > | |
| bool | is () const |
| Template function, checking if current instance is the type of another class. More... | |
| template<class T > | |
| bool | is () const |
| Template function, checking if current instance is the type of another class. More... | |
| template<class T > | |
| T | as () const |
| Template function, cast current instance as the type of another class. More... | |
| template<class T > | |
| T | as () const |
| Template function, cast current instance as the type of another class. More... | |
| rs2_frame * | get () const |
| Retrieve back the internal frame handle. More... | |
| rs2_frame * | get () const |
| Retrieve back the internal frame handle. More... | |
| operator rs2_frame * () | |
| operator rs2_frame * () | |
| frame | apply_filter (filter_interface &filter) |
| frame | apply_filter (filter_interface &filter) |
Protected Member Functions | |
| void | add_ref () const |
| add additional reference to a frame without duplicating frame data More... | |
| void | add_ref () const |
| add additional reference to a frame without duplicating frame data More... | |
| void | reset () |
| void | reset () |
|
inline |
Extends the frame class with additional point cloud related attributes and functions.
Definition at line 741 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inline |
Extends the frame class with additional point cloud related attributes and functions.
| [in] | frame | - existing frame instance |
Definition at line 747 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::frame::get(), rs2::error::handle(), rs2::frame::reset(), RS2_EXTENSION_POINTS, rs2_get_frame_points_count(), and rs2_is_frame_extendable_to().
|
inline |
Extends the frame class with additional point cloud related attributes and functions.
Definition at line 741 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inline |
Extends the frame class with additional point cloud related attributes and functions.
| [in] | frame | - existing frame instance |
Definition at line 747 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::frame::get(), rs2::error::handle(), rs2::frame::reset(), RS2_EXTENSION_POINTS, rs2_get_frame_points_count(), and rs2_is_frame_extendable_to().
|
inlineprotectedinherited |
add additional reference to a frame without duplicating frame data
| [out] | result | new frame reference, release by destructor |
Definition at line 604 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_frame_add_ref().
Referenced by rs2::frame::frame().
|
inlineprotectedinherited |
add additional reference to a frame without duplicating frame data
| [out] | result | new frame reference, release by destructor |
Definition at line 604 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_frame_add_ref().
|
inlineinherited |
Definition at line 593 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::filter::process().
|
inlineinherited |
Definition at line 593 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::filter::process().
|
inlineinherited |
Template function, cast current instance as the type of another class.
Definition at line 580 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
Referenced by rs2::frameset::get_pose_frame().
|
inlineinherited |
Template function, cast current instance as the type of another class.
Definition at line 580 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inline |
Export the point cloud to a PLY file.
| [in] | string | fname - file name of the PLY to be saved |
| [in] | video_frame | texture - the texture for the PLY. |
Definition at line 780 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::frame::get(), rs2::error::handle(), rs2_export_to_ply(), and absl::swap_internal::swap().
|
inline |
Export the point cloud to a PLY file.
| [in] | string | fname - file name of the PLY to be saved |
| [in] | video_frame | texture - the texture for the PLY. |
Definition at line 780 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::frame::get(), rs2::error::handle(), rs2_export_to_ply(), and absl::swap_internal::swap().
|
inlineinherited |
Retrieve back the internal frame handle.
Definition at line 590 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
Referenced by rs2::frame_source::allocate_motion_frame(), rs2::frame_source::allocate_points(), rs2::frame_source::allocate_video_frame(), rs2::depth_frame::depth_frame(), rs2::disparity_frame::disparity_frame(), export_to_ply(), rs2::video_frame::extract_target_dimensions(), rs2::frameset::foreach_rs(), rs2::frame_source::frame_ready(), rs2::frameset::frameset(), rs2::disparity_frame::get_baseline(), rs2::video_frame::get_bits_per_pixel(), rs2::depth_frame::get_distance(), rs2::video_frame::get_height(), rs2::pose_frame::get_pose_data(), rs2::video_frame::get_stride_in_bytes(), get_texture_coordinates(), rs2::depth_frame::get_units(), get_vertices(), rs2::video_frame::get_width(), rs2::motion_frame::motion_frame(), rs2::frameset::operator[](), points(), rs2::pose_frame::pose_frame(), and rs2::video_frame::video_frame().
|
inlineinherited |
Retrieve back the internal frame handle.
Definition at line 590 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inlineinherited |
retrieve data from frame handle
Definition at line 545 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_data().
Referenced by rs2::motion_frame::get_motion_data().
|
inlineinherited |
retrieve data from frame handle
Definition at line 545 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_data().
|
inlineinherited |
retrieve data size from frame handle
Definition at line 533 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_data_size().
|
inlineinherited |
retrieve data size from frame handle
Definition at line 533 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_data_size().
|
inlineinherited |
retrieve the current value of a single frame_metadata
| [in] | frame_metadata | the frame_metadata whose value should be retrieved |
Definition at line 497 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_metadata().
|
inlineinherited |
retrieve the current value of a single frame_metadata
| [in] | frame_metadata | the frame_metadata whose value should be retrieved |
Definition at line 497 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_metadata().
|
inlineinherited |
retrieve frame number (from frame handle)
Definition at line 521 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_number().
|
inlineinherited |
retrieve frame number (from frame handle)
Definition at line 521 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_number().
|
inlineinherited |
retrieve the timestamp domain
Definition at line 485 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_timestamp_domain().
|
inlineinherited |
retrieve the timestamp domain
Definition at line 485 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_timestamp_domain().
|
inlineinherited |
retrieve stream profile from frame handle
Definition at line 557 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_stream_profile().
|
inlineinherited |
retrieve stream profile from frame handle
Definition at line 557 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_stream_profile().
Referenced by rs2::frameset::first_or_default(), rs2::frameset::get_fisheye_frame(), rs2::frameset::get_infrared_frame(), rs2::frameset::get_pose_frame(), and rs2::pointcloud::map_to().
|
inlineinherited |
Definition at line 445 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_sensor().
|
inlineinherited |
Definition at line 445 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_sensor().
Referenced by rs2::sensor_from_frame().
|
inline |
Retrieve the texture coordinates (uv map) for the point cloud.
Definition at line 792 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::frame::get(), rs2::error::handle(), and rs2_get_frame_texture_coordinates().
|
inline |
Retrieve the texture coordinates (uv map) for the point cloud.
Definition at line 792 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::frame::get(), rs2::error::handle(), and rs2_get_frame_texture_coordinates().
|
inlineinherited |
retrieve the time at which the frame was captured During the frame's lifetime it receives timestamps both at the device and host levels.
The different timestamps are gathered and managed under the frame's Metadata attributes. Chronologically the list of timestamps comprises of: SENSOR_TIMESTAMP - Device clock. For video sensors designates the middle of exposure. Requires metadata support. FRAME_TIMESTAMP - Device clock. Stamped at the beginning of frame readout and transfer. Requires metadata support. BACKEND_TIMESTAMP - Host (EPOCH) clock in Kernel space. Frame transfer from USB Controller to the USB Driver. TIME_OF_ARRIVAL - Host (EPOCH) clock in User space. Frame transfer from the USB Driver to Librealsense.
During runtime the SDK dynamically selects the most correct representaion, based on both device and host capabilities: In case the frame metadata is not configured:
HW Timestamp (FRAME_TIMESTAMP), orGlobal Timestamp Host-corrected derivative of HW Timestamp required for multi-sensor/device synchronizationRS2_OPTION_GLOBAL_TIME_ENABLED option. To query which of the three alternatives is active use get_frame_timestamp_domain() function call Definition at line 474 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_timestamp().
|
inlineinherited |
retrieve the time at which the frame was captured During the frame's lifetime it receives timestamps both at the device and host levels.
The different timestamps are gathered and managed under the frame's Metadata attributes. Chronologically the list of timestamps comprises of: SENSOR_TIMESTAMP - Device clock. For video sensors designates the middle of exposure. Requires metadata support. FRAME_TIMESTAMP - Device clock. Stamped at the beginning of frame readout and transfer. Requires metadata support. BACKEND_TIMESTAMP - Host (EPOCH) clock in Kernel space. Frame transfer from USB Controller to the USB Driver. TIME_OF_ARRIVAL - Host (EPOCH) clock in User space. Frame transfer from the USB Driver to Librealsense.
During runtime the SDK dynamically selects the most correct representaion, based on both device and host capabilities: In case the frame metadata is not configured:
HW Timestamp (FRAME_TIMESTAMP), orGlobal Timestamp Host-corrected derivative of HW Timestamp required for multi-sensor/device synchronizationRS2_OPTION_GLOBAL_TIME_ENABLED option. To query which of the three alternatives is active use get_frame_timestamp_domain() function call Definition at line 474 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_get_frame_timestamp().
|
inline |
Retrieve the vertices of the point cloud.
| [in] | vertex* | - pointer of vertex sturcture |
Definition at line 767 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::frame::get(), rs2::error::handle(), and rs2_get_frame_vertices().
|
inline |
Retrieve the vertices of the point cloud.
| [in] | vertex* | - pointer of vertex sturcture |
Definition at line 767 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::frame::get(), rs2::error::handle(), and rs2_get_frame_vertices().
|
inlineinherited |
Template function, checking if current instance is the type of another class.
Definition at line 570 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inlineinherited |
Template function, checking if current instance is the type of another class.
Definition at line 570 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inlineinherited |
keep the frame, otherwise if no refernce to the frame, the frame will be released.
Definition at line 437 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2_keep_frame().
Referenced by rs2::frame_queue::enqueue().
|
inlineinherited |
keep the frame, otherwise if no refernce to the frame, the frame will be released.
Definition at line 437 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2_keep_frame().
|
inlineinherited |
Parenthesis operator check if internal frame handle is valid.
Definition at line 443 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inlineinherited |
Parenthesis operator check if internal frame handle is valid.
Definition at line 443 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inlineexplicitinherited |
Definition at line 591 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inlineexplicitinherited |
Definition at line 591 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inlineprotectedinherited |
Definition at line 611 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2_release_frame().
Referenced by rs2::depth_frame::depth_frame(), rs2::disparity_frame::disparity_frame(), rs2::frameset::frameset(), rs2::motion_frame::motion_frame(), points(), rs2::pose_frame::pose_frame(), and rs2::video_frame::video_frame().
|
inlineprotectedinherited |
Definition at line 611 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2_release_frame().
|
inline |
Definition at line 800 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inline |
Definition at line 800 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
|
inlineinherited |
determine if the device allows a specific metadata to be queried
| [in] | frame_metadata | the frame_metadata to check for support |
Definition at line 509 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_supports_frame_metadata().
|
inlineinherited |
determine if the device allows a specific metadata to be queried
| [in] | frame_metadata | the frame_metadata to check for support |
Definition at line 509 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References rs2::error::handle(), and rs2_supports_frame_metadata().
|
inlineinherited |
Swap the internal frame handle with the one in parameter.
| [in] | frame | other - another frame instance to be swaped |
Definition at line 413 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References absl::swap_internal::swap().
Referenced by rs2::frame::operator=().
|
inlineinherited |
Swap the internal frame handle with the one in parameter.
| [in] | frame | other - another frame instance to be swaped |
Definition at line 413 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_frame.hpp.
References absl::swap_internal::swap().