rs::frame Class Reference

#include <rs.hpp>

Public Member Functions
	frame ()
	frame (rs_device *device, rs_frame_ref *frame_ref)
	frame (frame &&other)
frame &	operator= (frame other)
void	swap (frame &other)
	~frame ()
double	get_timestamp () const
timestamp_domain	get_frame_timestamp_domain () const
double	get_frame_metadata (rs_frame_metadata frame_metadata) const
bool	supports_frame_metadata (rs_frame_metadata frame_metadata) const
unsigned long long	get_frame_number () const
const void *	get_data () const
int	get_width () const
int	get_height () const
int	get_framerate () const
int	get_stride () const
int	get_bpp () const
format	get_format () const
stream	get_stream_type () const

Constructor & Destructor Documentation

frame() [1/3]

rs::frame::frame ( )

inline

frame() [2/3]

rs::frame::frame ( rs_device *  device, rs_frame_ref *  frame_ref  )

inline

frame() [3/3]

rs::frame::frame ( frame &&  other )

inline

~frame()

rs::frame::~frame ( )

inline

Member Function Documentation

get_bpp()

int rs::frame::get_bpp ( ) const

inline

retrieve bits per pixel

Returns

number of bits per one pixel

get_data()

const void* rs::frame::get_data ( ) const

inline

get_format()

format rs::frame::get_format ( ) const

inline

get_frame_metadata()

double rs::frame::get_frame_metadata ( rs_frame_metadata  frame_metadata ) const

inline

retrieve the current value of a single frame_metadata

Parameters

[in]

frame_metadata

the frame_metadata whose value should be retrieved

Returns

the value of the frame_metadata

get_frame_number()

unsigned long long rs::frame::get_frame_number ( ) const

inline

get_frame_timestamp_domain()

timestamp_domain rs::frame::get_frame_timestamp_domain ( ) const

inline

retrieve the timestamp domain

Returns

timestamp domain (clock name) for timestamp values

get_framerate()

int rs::frame::get_framerate ( ) const

inline

get_height()

int rs::frame::get_height ( ) const

inline

get_stream_type()

stream rs::frame::get_stream_type ( ) const

inline

get_stride()

int rs::frame::get_stride ( ) const

inline

get_timestamp()

double rs::frame::get_timestamp ( ) const

inline

retrieve the time at which the frame was captured

Returns

the timestamp of the frame, in milliseconds since the device was started

get_width()

int rs::frame::get_width ( ) const

inline

operator=()

frame& rs::frame::operator= ( frame  other )

inline

supports_frame_metadata()

bool rs::frame::supports_frame_metadata ( rs_frame_metadata  frame_metadata ) const

inline

determine if the device allows a specific metadata to be queried

Parameters

[in]

frame_metadata

the 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-1.12.1/include/librealsense/rs.hpp