Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Public Member Functions | List of all members
rs2::video_frame Class Reference

#include <rs_frame.hpp>

Inheritance diagram for rs2::video_frame:
rs2::frame rs2::depth_frame rs2::disparity_frame

Public Member Functions

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

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ video_frame()

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

Extends the frame class with additional video related attributes and functions

[in]frame- existing frame instance

Member Function Documentation

◆ extract_target_dimensions()

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

Extract the 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. 4 for RS2_CALIB_TARGET_RECT_GAUSSIAN_DOT_VERTICES and 8 for RS2_CALIB_TARGET_POS_GAUSSIAN_DOT_VERTICES
[out]target_dimsThe array to hold the result target dimensions calculated. For type RS2_CALIB_TARGET_RECT_GAUSSIAN_DOT_VERTICES and RS2_CALIB_TARGET_ROI_RECT_GAUSSIAN_DOT_VERTICES, the four rectangle side sizes in pixels with the order of top, bottom, left, and right For type RS2_CALIB_TARGET_POS_GAUSSIAN_DOT_VERTICES, the four vertices coordinates 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

◆ get_bits_per_pixel()

int rs2::video_frame::get_bits_per_pixel ( ) const

retrieve bits per pixel

number of bits per one pixel

◆ get_bytes_per_pixel()

int rs2::video_frame::get_bytes_per_pixel ( ) const

retrieve bytes per pixel

number of bytes per one pixel

◆ get_height()

int rs2::video_frame::get_height ( ) const

returns image height in pixels

frame height in pixels

◆ get_stride_in_bytes()

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

◆ get_width()

int rs2::video_frame::get_width ( ) const

returns image width in pixels

frame width in pixels

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