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

#include <rs_frame.hpp>

Inheritance diagram for rs2::video_frame:
Inheritance graph
[legend]

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)
inline

Extends the frame class with additional video related attributes and functions

Parameters
[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
inline

Calculate the rectangle size on the specific target

Parameters
[in]frameLeft or right camera frame of size 256x144
[out]rec_sidesThe four rectangle side sizes in pixels with the order of top, bottom, left, and right
Returns
true if succeeded

Definition at line 715 of file rs_frame.hpp.

int rs2::video_frame::get_bits_per_pixel ( ) const
inline

retrieve bits per pixel

Returns
number of bits per one pixel

Definition at line 695 of file rs_frame.hpp.

int rs2::video_frame::get_bytes_per_pixel ( ) const
inline

retrieve bytes per pixel

Returns
number of bytes per one pixel

Definition at line 707 of file rs_frame.hpp.

int rs2::video_frame::get_height ( ) const
inline

returns image height in pixels

Returns
frame height in pixels

Definition at line 671 of file rs_frame.hpp.

int rs2::video_frame::get_stride_in_bytes ( ) const
inline

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

Returns
stride in bytes

Definition at line 683 of file rs_frame.hpp.

int rs2::video_frame::get_width ( ) const
inline

returns image width in pixels

Returns
frame width in pixels

Definition at line 659 of file rs_frame.hpp.


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


librealsense2
Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Sat Apr 3 2021 02:51:29