Frame.
More...
#include <rs.hpp>
Frame.
Definition at line 392 of file rs.hpp.
rs::frame::frame |
( |
const frame & |
| ) |
|
|
privatedelete |
rs::frame::frame |
( |
frame && |
other | ) |
|
|
inline |
int rs::frame::get_bpp |
( |
| ) |
const |
|
inline |
Retrieves bits per pixel.
- Returns
- Number of bits per one pixel
Definition at line 524 of file rs.hpp.
const void* rs::frame::get_data |
( |
| ) |
const |
|
inline |
Retrieves frame content
- Returns
- Frame content
Definition at line 478 of file rs.hpp.
format rs::frame::get_format |
( |
| ) |
const |
|
inline |
Retrieves frame format.
- Returns
- Frame format
Definition at line 534 of file rs.hpp.
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
Definition at line 447 of file rs.hpp.
unsigned long long rs::frame::get_frame_number |
( |
| ) |
const |
|
inline |
Retrieves frame number
- Returns
- Frame number
Definition at line 468 of file rs.hpp.
Retrieves the timestamp domain
- Returns
- Timestamp domain (clock name) for timestamp values
Definition at line 436 of file rs.hpp.
int rs::frame::get_framerate |
( |
| ) |
const |
|
inline |
Returns configured frame rate.
Definition at line 505 of file rs.hpp.
int rs::frame::get_height |
( |
| ) |
const |
|
inline |
Returns image height in pixels.
Definition at line 496 of file rs.hpp.
stream rs::frame::get_stream_type |
( |
| ) |
const |
|
inline |
Retrieves frame stream type.
- Returns
- Frame stream type
Definition at line 544 of file rs.hpp.
int rs::frame::get_stride |
( |
| ) |
const |
|
inline |
Retrieves frame stride, meaning the actual line width in memory in bytes (not the logical image width)
Definition at line 514 of file rs.hpp.
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
Definition at line 426 of file rs.hpp.
int rs::frame::get_width |
( |
| ) |
const |
|
inline |
Returns image width in pixels.
Definition at line 487 of file rs.hpp.
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
Definition at line 458 of file rs.hpp.
The documentation for this class was generated from the following file: