Public Member Functions | List of all members
rs2::video_frame Class Reference

#include <rs_frame.hpp>

Inheritance diagram for rs2::video_frame:
Inheritance graph

Public Member Functions

bool extract_target_dimensions (rs2_calib_target_type calib_type, float *target_dims, unsigned int target_dims_size) const
int get_bits_per_pixel () const
int get_bytes_per_pixel () const
int get_height () const
int get_stride_in_bytes () const
int get_width () const
 video_frame (const frame &f)
- Public Member Functions inherited from rs2::frame
frame apply_filter (filter_interface &filter)
template<class T >
as () const
 frame ()
 frame (rs2_frame *ref)
 frame (frame &&other) noexcept
 frame (const frame &other)
rs2_frameget () const
const voidget_data () const
const int get_data_size () const
rs2_metadata_type get_frame_metadata (rs2_frame_metadata_value frame_metadata) const
unsigned long long get_frame_number () const
rs2_timestamp_domain get_frame_timestamp_domain () const
stream_profile get_profile () const
rs2_sensorget_sensor ()
double get_timestamp () const
template<class T >
bool is () const
void keep ()
 operator bool () const
 operator rs2_frame * ()
frameoperator= (frame other)
bool supports_frame_metadata (rs2_frame_metadata_value frame_metadata) const
void swap (frame &other)
 ~frame ()

Additional Inherited Members

- Protected Member Functions inherited from rs2::frame
void add_ref () const
void reset ()

Detailed Description

Definition at line 636 of file rs_frame.hpp.

Constructor & Destructor Documentation

rs2::video_frame::video_frame ( const frame f)

Extends the frame class with additional video related attributes and functions

[in]frame- existing frame instance

Definition at line 643 of file rs_frame.hpp.

Member Function Documentation

bool rs2::video_frame::extract_target_dimensions ( rs2_calib_target_type  calib_type,
float *  target_dims,
unsigned int  target_dims_size 
) const

Extract the target dimensions on the specific target

[in]frameLeft or right camera frame of specified size based on the target type
[in]calib_typeCalibration target type
[in]target_dims_sizeTarget dimension array size
[out]target_dimsThe array to hold the result target dimensions calculated. For type RS2_CALIB_TARGET_RECT_GAUSSIAN_DOT_VERTICES, the four rectangle side sizes in pixels with the order of top, bottom, left, and right
[out]errorIf non-null, receives any error that occurs during this call, otherwise, errors are ignored

Definition at line 717 of file rs_frame.hpp.

int rs2::video_frame::get_bits_per_pixel ( ) const

retrieve bits per pixel

number of bits per one pixel

Definition at line 695 of file rs_frame.hpp.

int rs2::video_frame::get_bytes_per_pixel ( ) const

retrieve bytes per pixel

number of bytes per one pixel

Definition at line 707 of file rs_frame.hpp.

int rs2::video_frame::get_height ( ) const

returns image height in pixels

frame height in pixels

Definition at line 671 of file rs_frame.hpp.

int rs2::video_frame::get_stride_in_bytes ( ) const

retrieve frame stride, meaning the actual line width in memory in bytes (not the logical image width)

stride in bytes

Definition at line 683 of file rs_frame.hpp.

int rs2::video_frame::get_width ( ) const

returns image width in pixels

frame width in pixels

Definition at line 659 of file rs_frame.hpp.

The documentation for this class was generated from the following file:

Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Mon May 3 2021 02:50:41