Frame. More...

#include <rs.hpp>

Public Member Functions
	frame ()

	frame (rs_device device, rs_frame_ref frame_ref)

	frame (frame &&other)

int	get_bpp () const
	Retrieves bits per pixel. More...

const void *	get_data () const

format	get_format () const
	Retrieves frame format. More...

double	get_frame_metadata (rs_frame_metadata frame_metadata) const

unsigned long long	get_frame_number () const

timestamp_domain	get_frame_timestamp_domain () const

int	get_framerate () const
	Returns configured frame rate. More...

int	get_height () const
	Returns image height in pixels. More...

stream	get_stream_type () const
	Retrieves frame stream type. More...

int	get_stride () const
	Retrieves frame stride, meaning the actual line width in memory in bytes (not the logical image width) More...

double	get_timestamp () const

int	get_width () const
	Returns image width in pixels. More...

frame &	operator= (frame other)

bool	supports_frame_metadata (rs_frame_metadata frame_metadata) const

void	swap (frame &other)

	~frame ()

Private Member Functions
	frame (const frame &)=delete

Private Attributes
rs_device *	device

rs_frame_ref *	frame_ref

Detailed Description

Frame.

Definition at line 392 of file rs.hpp.

Constructor & Destructor Documentation

rs::frame::frame ( const frame & )

privatedelete

rs::frame::frame ( )

inline

Definition at line 400 of file rs.hpp.

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

inline

Definition at line 401 of file rs.hpp.

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

inline

Definition at line 402 of file rs.hpp.

rs::frame::~frame ( )

inline

Definition at line 414 of file rs.hpp.

Member Function Documentation

int rs::frame::get_bpp ( ) const

inline

Retrieves bits per pixel.

Returns: Number of bits per one pixel

Definition at line 524 of file rs.hpp.

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

inline

Retrieves frame content

Returns: Frame content

Definition at line 478 of file rs.hpp.

format rs::frame::get_format ( ) const

inline

Retrieves frame format.

Returns: Frame format

Definition at line 534 of file rs.hpp.

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

inline

Retrieves the current value of a single frame_metadata

Parameters

[in] frame_metadata Frame metadata whose value should be retrieved

Returns: Value of frame_metadata

Definition at line 447 of file rs.hpp.

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

inline

Retrieves frame number

Returns: Frame number

Definition at line 468 of file rs.hpp.

timestamp_domain rs::frame::get_frame_timestamp_domain ( ) const

inline

Retrieves the timestamp domain

Returns: Timestamp domain (clock name) for timestamp values

Definition at line 436 of file rs.hpp.

int rs::frame::get_framerate ( ) const

inline

Returns configured frame rate.

Definition at line 505 of file rs.hpp.

int rs::frame::get_height ( ) const

inline

Returns image height in pixels.

Definition at line 496 of file rs.hpp.

stream rs::frame::get_stream_type ( ) const

inline

Retrieves frame stream type.

Returns: Frame stream type

Definition at line 544 of file rs.hpp.

int rs::frame::get_stride ( ) const

inline

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

Definition at line 514 of file rs.hpp.

double rs::frame::get_timestamp ( ) const

inline

Retrieves time at which frame was captured

Returns: Timestamp of the frame, in milliseconds since the device was started

Definition at line 426 of file rs.hpp.

int rs::frame::get_width ( ) const

inline

Returns image width in pixels.

Definition at line 487 of file rs.hpp.

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

inline

Definition at line 403 of file rs.hpp.

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

inline

Determines if device allows specific metadata to be queried

Parameters

[in] frame_metadata Frame_metadata to check for support

Returns: true if the frame_metadata can be queried

Definition at line 458 of file rs.hpp.

void rs::frame::swap ( frame & other )

inline

Definition at line 408 of file rs.hpp.

Member Data Documentation

rs_device* rs::frame::device

private

Definition at line 394 of file rs.hpp.

rs_frame_ref* rs::frame::frame_ref

private

Definition at line 395 of file rs.hpp.

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

rs.hpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation