#include <rs_frame.hpp>
§ frame() [1/4]
§ frame() [2/4]
§ frame() [3/4]
rs2::frame::frame |
( |
frame && |
other | ) |
|
|
inlinenoexcept |
§ frame() [4/4]
rs2::frame::frame |
( |
const frame & |
other | ) |
|
|
inline |
§ ~frame()
releases the frame handle
§ add_ref()
void rs2::frame::add_ref |
( |
| ) |
const |
|
inlineprotected |
create additional reference to a frame without duplicating frame data
- Parameters
-
[out] | result | new frame reference, release by destructor |
- Returns
- true if cloning was successful
§ as()
template<class T >
T rs2::frame::as |
( |
| ) |
const |
|
inline |
§ get()
§ get_data()
const void* rs2::frame::get_data |
( |
| ) |
const |
|
inline |
retrieve data from frame handle
- Returns
- the pointer to the start of the frame data
§ get_frame_metadata()
retrieve the current value of a single frame_metadata
- Parameters
-
[in] | frame_metadata | the frame_metadata whose value should be retrieved |
- Returns
- the value of the frame_metadata
§ get_frame_number()
unsigned long long rs2::frame::get_frame_number |
( |
| ) |
const |
|
inline |
retrieve frame number (from frame handle)
- Returns
- the frame number of the frame, in milliseconds since the device was started
§ get_frame_timestamp_domain()
retrieve the timestamp domain
- Returns
- timestamp domain (clock name) for timestamp values
§ get_profile()
§ get_timestamp()
double rs2::frame::get_timestamp |
( |
| ) |
const |
|
inline |
retrieve the time at which the frame was captured
- Returns
- the timestamp of the frame, in milliseconds since the device was started
§ is()
template<class T >
bool rs2::frame::is |
( |
| ) |
const |
|
inline |
§ keep()
void rs2::frame::keep |
( |
| ) |
|
|
inline |
§ operator bool()
rs2::frame::operator bool |
( |
| ) |
const |
|
inline |
§ operator=()
§ reset()
void rs2::frame::reset |
( |
| ) |
|
|
inlineprotected |
§ supports_frame_metadata()
determine if the device allows a specific metadata to be queried
- Parameters
-
[in] | frame_metadata | the frame_metadata to check for support |
- Returns
- true if the frame_metadata can be queried
§ swap()
void rs2::frame::swap |
( |
frame & |
other | ) |
|
|
inline |
§ rs2::frame_queue
§ rs2::frame_source
§ rs2::pointcloud
§ rs2::points
§ rs2::processing_block
§ rs2::syncer
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/librealsense-2.11.1/include/librealsense2/hpp/rs_frame.hpp