rs2::video_stream_profile Class Reference

#include <rs_frame.hpp>

Inheritance diagram for rs2::video_stream_profile:

Public Member Functions
	video_stream_profile ()
	video_stream_profile (const stream_profile &sp)
int	width () const
int	height () const
rs2_intrinsics	get_intrinsics () const
bool	operator== (const video_stream_profile &other) const
stream_profile	clone (rs2_stream type, int index, rs2_format format, int width, int height, const rs2_intrinsics &intr) const
stream_profile	clone (rs2_stream type, int index, rs2_format format) const
Public Member Functions inherited from rs2::stream_profile
	stream_profile ()
int	stream_index () const
rs2_stream	stream_type () const
rs2_format	format () const
int	fps () const
int	unique_id () const
stream_profile	clone (rs2_stream type, int index, rs2_format format) const
bool	operator== (const stream_profile &rhs)
template<class T >
bool	is () const
template<class T >
T	as () const
std::string	stream_name () const
bool	is_default () const
	operator bool () const
const rs2_stream_profile *	get () const
rs2_extrinsics	get_extrinsics_to (const stream_profile &to) const
void	register_extrinsics_to (const stream_profile &to, rs2_extrinsics extrinsics)
bool	is_cloned ()
	stream_profile (const rs2_stream_profile *profile)
	operator const rs2_stream_profile * ()
	operator std::shared_ptr< rs2_stream_profile > ()

Additional Inherited Members
Protected Attributes inherited from rs2::stream_profile
const rs2_stream_profile *	_profile
std::shared_ptr< rs2_stream_profile >	_clone
int	_index = 0
int	_uid = 0
int	_framerate = 0
rs2_format	_format = RS2_FORMAT_ANY
rs2_stream	_type = RS2_STREAM_ANY
bool	_default = false

Constructor & Destructor Documentation

video_stream_profile() [1/2]

rs2::video_stream_profile::video_stream_profile ( )

inline

video_stream_profile() [2/2]

rs2::video_stream_profile::video_stream_profile ( const stream_profile &  sp )

inlineexplicit

Stream profile instance which contains additional video attributes

Parameters

[in]

stream_profile

sp - assign exisiting stream_profile to this instance.

Member Function Documentation

clone() [1/2]

stream_profile rs2::stream_profile::clone

inline

Clone the current profile and change the type, index and format to input parameters

Parameters

[in]	type	- will change the stream type from the cloned profile.
[in]	index	- will change the stream index from the cloned profile.
[in]	format	- will change the stream format from the cloned profile.

Returns

stream_profile - return the cloned stream profile.

clone() [2/2]

stream_profile rs2::video_stream_profile::clone ( rs2_stream  type, int  index, rs2_format  format, int  width, int  height, const rs2_intrinsics &  intr  ) const

inline

Clone current profile and change the type, index and format to input parameters

Parameters

[in]	type	- will change the stream type from the cloned profile.
[in]	index	- will change the stream index from the cloned profile.
[in]	format	- will change the stream format from the cloned profile.
[in]	width	- will change the width of the profile
[in]	height	- will change the height of the profile
[in]	intr	- will change the intrinsics of the profile

Returns

stream_profile - return the cloned stream profile.

get_intrinsics()

rs2_intrinsics rs2::video_stream_profile::get_intrinsics ( ) const

inline

Get stream profile instrinsics attributes

Returns

rs2_intrinsics - stream intrinsics.

height()

int rs2::video_stream_profile::height ( ) const

inline

operator==()

bool rs2::video_stream_profile::operator== ( const video_stream_profile &  other ) const

inline

width()

int rs2::video_stream_profile::width ( ) const

inline

---

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

• C:/jenkins_sys_rsbuild/workspace/LRS_doxygen_pipeline/source/include/librealsense2/hpp/rs_frame.hpp