Frame.
More...
#include <rs.hpp>
◆ frame() [1/3]
◆ frame() [2/3]
◆ frame() [3/3]
rs::frame::frame |
( |
frame && |
other | ) |
|
|
inline |
◆ ~frame()
◆ get_bpp()
int rs::frame::get_bpp |
( |
| ) |
const |
|
inline |
Retrieves bits per pixel.
- Returns
- Number of bits per one pixel
◆ get_data()
const void* rs::frame::get_data |
( |
| ) |
const |
|
inline |
Retrieves frame content
- Returns
- Frame content
◆ get_format()
format rs::frame::get_format |
( |
| ) |
const |
|
inline |
Retrieves frame format.
- Returns
- Frame format
◆ get_frame_metadata()
Retrieves the current value of a single frame_metadata
- Parameters
-
[in] | frame_metadata | Frame metadata whose value should be retrieved |
- Returns
- Value of frame_metadata
◆ get_frame_number()
unsigned long long rs::frame::get_frame_number |
( |
| ) |
const |
|
inline |
Retrieves frame number
- Returns
- Frame number
◆ get_frame_timestamp_domain()
Retrieves the timestamp domain
- Returns
- Timestamp domain (clock name) for timestamp values
◆ get_framerate()
int rs::frame::get_framerate |
( |
| ) |
const |
|
inline |
Returns configured frame rate.
◆ get_height()
int rs::frame::get_height |
( |
| ) |
const |
|
inline |
Returns image height in pixels.
◆ get_stream_type()
stream rs::frame::get_stream_type |
( |
| ) |
const |
|
inline |
Retrieves frame stream type.
- Returns
- Frame stream type
◆ get_stride()
int rs::frame::get_stride |
( |
| ) |
const |
|
inline |
Retrieves frame stride, meaning the actual line width in memory in bytes (not the logical image width)
◆ get_timestamp()
double rs::frame::get_timestamp |
( |
| ) |
const |
|
inline |
Retrieves time at which frame was captured
- Returns
- Timestamp of the frame, in milliseconds since the device was started
◆ get_width()
int rs::frame::get_width |
( |
| ) |
const |
|
inline |
Returns image width in pixels.
◆ operator=()
◆ supports_frame_metadata()
Determines if device allows specific metadata to be queried
- Parameters
-
[in] | frame_metadata | Frame_metadata to check for support |
- Returns
- true if the frame_metadata can be queried
◆ swap()
void rs::frame::swap |
( |
frame & |
other | ) |
|
|
inline |
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/librealsense-24ddaecfc6e1099f96330757181174e7054d6cd6/include/librealsense/rs.hpp