rs2::frame Class Reference

#include <rs_frame.hpp>

Inheritance diagram for rs2::frame:

Public Member Functions
	frame ()
	frame (rs2_frame *frame_ref)
	frame (frame &&other) noexcept
frame &	operator= (frame other)
	frame (const frame &other)
void	swap (frame &other)
	~frame ()
void	keep ()
	operator bool () const
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 void *	get_data () const
stream_profile	get_profile () const
template<class T >
bool	is () const
template<class T >
T	as () const
rs2_frame *	get () const

Protected Member Functions
void	add_ref () const
void	reset ()

Friends
class	rs2::frame_source
class	rs2::frame_queue
class	rs2::syncer
class	rs2::processing_block
class	rs2::pointcloud
class	rs2::points

Constructor & Destructor Documentation

frame() [1/4]

rs2::frame::frame ( )

inline

frame() [2/4]

rs2::frame::frame ( rs2_frame *  frame_ref )

inline

frame() [3/4]

rs2::frame::frame ( frame &&  other )

inlinenoexcept

frame() [4/4]

rs2::frame::frame ( const frame &  other )

inline

~frame()

rs2::frame::~frame ( )

inline

releases the frame handle

Member Function Documentation

add_ref()

void rs2::frame::add_ref ( ) const

inlineprotected

create additional reference to a frame without duplicating frame data

Parameters

[out]

result

new frame reference, release by destructor

Returns

true if cloning was successful

as()

template<class T >

T rs2::frame::as ( ) const

inline

get()

rs2_frame* rs2::frame::get ( ) const

inline

get_data()

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

inline

retrieve data from frame handle

Returns

the pointer to the start of the frame data

get_frame_metadata()

rs2_metadata_type rs2::frame::get_frame_metadata ( rs2_frame_metadata_value  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 rs2::frame::get_frame_number ( ) const

inline

retrieve frame number (from frame handle)

Returns

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

get_frame_timestamp_domain()

rs2_timestamp_domain rs2::frame::get_frame_timestamp_domain ( ) const

inline

retrieve the timestamp domain

Returns

timestamp domain (clock name) for timestamp values

get_profile()

stream_profile rs2::frame::get_profile ( ) const

inline

get_timestamp()

double rs2::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

is()

template<class T >

bool rs2::frame::is ( ) const

inline

keep()

void rs2::frame::keep ( )

inline

operator bool()

rs2::frame::operator bool ( ) const

inline

operator=()

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

inline

reset()

void rs2::frame::reset ( )

inlineprotected

supports_frame_metadata()

bool rs2::frame::supports_frame_metadata ( rs2_frame_metadata_value  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 rs2::frame::swap ( frame &  other )

inline

Friends And Related Function Documentation

rs2::frame_queue

friend class rs2::frame_queue

friend

rs2::frame_source

friend class rs2::frame_source

friend

rs2::pointcloud

friend class rs2::pointcloud

friend

rs2::points

friend class rs2::points

friend

rs2::processing_block

friend class rs2::processing_block

friend

rs2::syncer

friend class rs2::syncer

friend

---

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

• C:/librealsense-2.13.0/include/librealsense2/hpp/rs_frame.hpp