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

Frame. More...

#include <rs.hpp>

Public Member Functions

 frame ()
 
 frame (rs_device *device, rs_frame_ref *frame_ref)
 
 frame (frame &&other)
 
frameoperator= (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
 Returns image width in pixels. More...
 
int get_height () const
 Returns image height in pixels. More...
 
int get_framerate () const
 Returns configured frame rate. More...
 
int get_stride () const
 Retrieves frame stride, meaning the actual line width in memory in bytes (not the logical image width) More...
 
int get_bpp () const
 Retrieves bits per pixel. More...
 
format get_format () const
 Retrieves frame format. More...
 
stream get_stream_type () const
 Retrieves frame stream type. More...
 

Detailed Description

Frame.

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

Retrieves bits per pixel.

Returns
Number of bits per one pixel

◆ get_data()

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

Retrieves frame content

Returns
Frame content

◆ get_format()

format rs::frame::get_format ( ) const
inline

Retrieves frame format.

Returns
Frame format

◆ get_frame_metadata()

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_metadataFrame metadata whose value should be retrieved
Returns
Value of frame_metadata

◆ get_frame_number()

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

Retrieves frame number

Returns
Frame number

◆ get_frame_timestamp_domain()

timestamp_domain rs::frame::get_frame_timestamp_domain ( ) const
inline

Retrieves the timestamp domain

Returns
Timestamp domain (clock name) for timestamp values

◆ get_framerate()

int rs::frame::get_framerate ( ) const
inline

Returns configured frame rate.

◆ get_height()

int rs::frame::get_height ( ) const
inline

Returns image height in pixels.

◆ get_stream_type()

stream rs::frame::get_stream_type ( ) const
inline

Retrieves frame stream type.

Returns
Frame stream type

◆ get_stride()

int rs::frame::get_stride ( ) const
inline

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

◆ get_timestamp()

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

◆ get_width()

int rs::frame::get_width ( ) const
inline

Returns image width in pixels.

◆ operator=()

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

◆ supports_frame_metadata()

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_metadataFrame_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: