Detailed Description

Exposes librealsense functionality for C compilers.

Definition in file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

Macros
#define	RS2_API_MAJOR_VERSION 2

#define	RS2_API_MINOR_VERSION 48

#define	RS2_API_PATCH_VERSION 0

#define	RS2_API_BUILD_VERSION 0

#define	STRINGIFY(arg) #arg

#define	VAR_ARG_STRING(arg) STRINGIFY(arg)

#define	RS2_API_VERSION (((RS2_API_MAJOR_VERSION) * 10000) + ((RS2_API_MINOR_VERSION) * 100) + (RS2_API_PATCH_VERSION))

#define	RS2_API_VERSION_STR (VAR_ARG_STRING(RS2_API_MAJOR_VERSION.RS2_API_MINOR_VERSION.RS2_API_PATCH_VERSION))

#define	RS2_API_FULL_VERSION_STR (VAR_ARG_STRING(RS2_API_MAJOR_VERSION.RS2_API_MINOR_VERSION.RS2_API_PATCH_VERSION.RS2_API_BUILD_VERSION))

Functions
int	rs2_get_raw_data_size (const rs2_raw_data_buffer buffer, rs2_error *error)
	get the size of rs2_raw_data_buffer More...

void	rs2_delete_raw_data (const rs2_raw_data_buffer *buffer)
	Delete rs2_raw_data_buffer. More...

const unsigned char *	rs2_get_raw_data (const rs2_raw_data_buffer buffer, rs2_error *error)
	Retrieve char array from rs2_raw_data_buffer. More...

int	rs2_get_api_version (rs2_error **error)
	Retrieve the API version from the source code. More...

void	rs2_log_to_console (rs2_log_severity min_severity, rs2_error **error)

void	rs2_log_to_file (rs2_log_severity min_severity, const char file_path, rs2_error *error)

void	rs2_log_to_callback_cpp (rs2_log_severity min_severity, rs2_log_callback callback, rs2_error *error)

void	rs2_log_to_callback (rs2_log_severity min_severity, rs2_log_callback_ptr callback, void arg, rs2_error *error)

void	rs2_reset_logger (rs2_error **error)

void	rs2_enable_rolling_log_file (unsigned max_size, rs2_error **error)
	Enable rolling log file when used with rs2_log_to_file: Upon reaching (max_size/2) bytes, the log will be renamed with an ".old" suffix and a new log created. More...

unsigned	rs2_get_log_message_line_number (rs2_log_message const msg, rs2_error *error)

const char *	rs2_get_log_message_filename (rs2_log_message const msg, rs2_error *error)

const char *	rs2_get_raw_log_message (rs2_log_message const msg, rs2_error *error)

const char *	rs2_get_full_log_message (rs2_log_message const msg, rs2_error *error)

void	rs2_log (rs2_log_severity severity, const char message, rs2_error *error)
	Add custom message into librealsense log. More...

float	rs2_depth_frame_get_distance (const rs2_frame frame_ref, int x, int y, rs2_error *error)
	Given the 2D depth coordinate (x,y) provide the corresponding depth in metric units. More...

rs2_time_t	rs2_get_time (rs2_error **error)
	return the time at specific time point More...

Macro Definition Documentation

◆ RS2_API_BUILD_VERSION

#define RS2_API_BUILD_VERSION 0

Definition at line 28 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

◆ RS2_API_FULL_VERSION_STR

#define RS2_API_FULL_VERSION_STR (VAR_ARG_STRING(RS2_API_MAJOR_VERSION.RS2_API_MINOR_VERSION.RS2_API_PATCH_VERSION.RS2_API_BUILD_VERSION))

Definition at line 44 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

◆ RS2_API_MAJOR_VERSION

#define RS2_API_MAJOR_VERSION 2

Definition at line 25 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

◆ RS2_API_MINOR_VERSION

#define RS2_API_MINOR_VERSION 48

Definition at line 26 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

◆ RS2_API_PATCH_VERSION

#define RS2_API_PATCH_VERSION 0

Definition at line 27 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

◆ RS2_API_VERSION

#define RS2_API_VERSION (((RS2_API_MAJOR_VERSION) * 10000) + ((RS2_API_MINOR_VERSION) * 100) + (RS2_API_PATCH_VERSION))

Definition at line 41 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

◆ RS2_API_VERSION_STR

#define RS2_API_VERSION_STR (VAR_ARG_STRING(RS2_API_MAJOR_VERSION.RS2_API_MINOR_VERSION.RS2_API_PATCH_VERSION))

Definition at line 43 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

◆ STRINGIFY

#define STRINGIFY ( arg ) #arg

Definition at line 31 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

◆ VAR_ARG_STRING

#define VAR_ARG_STRING ( arg ) STRINGIFY(arg)

Definition at line 34 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/rs.h.

Function Documentation

◆ rs2_delete_raw_data()

void rs2_delete_raw_data ( const rs2_raw_data_buffer * buffer )

Delete rs2_raw_data_buffer.

Parameters

[in] buffer rs2_raw_data_buffer returned by rs2_send_and_receive_raw_data

Referenced by rs2::updatable::create_flash_backup(), rs2::pose_sensor::export_localization_map(), rs2::auto_calibrated_device::get_calibration_table(), rs2::terminal_parser::parse_command(), rs2::terminal_parser::parse_response(), rs2::auto_calibrated_device::run_on_chip_calibration(), rs2::auto_calibrated_device::run_tare_calibration(), rs2::debug_protocol::send_and_receive_raw_data(), and rs2::serializable_device::serialize_json().

◆ rs2_depth_frame_get_distance()

float rs2_depth_frame_get_distance	(	const rs2_frame *	frame_ref,
		int	x,
		int	y,
		rs2_error **	error
	)

Given the 2D depth coordinate (x,y) provide the corresponding depth in metric units.

Parameters

[in]	frame_ref	2D depth pixel coordinates (Left-Upper corner origin)
[in]	x,y	2D depth pixel coordinates (Left-Upper corner origin)
[out]	error	if non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::depth_frame::get_distance().

◆ rs2_enable_rolling_log_file()

void rs2_enable_rolling_log_file	(	unsigned	max_size,
		rs2_error **	error
	)

Enable rolling log file when used with rs2_log_to_file: Upon reaching (max_size/2) bytes, the log will be renamed with an ".old" suffix and a new log created.

Any previous .old file will be erased. Must have permissions to remove/rename files in log file directory.

Parameters

[in]	max_size	max file size in megabytes
[out]	error	if non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::enable_rolling_log_file().

◆ rs2_get_api_version()

int rs2_get_api_version ( rs2_error ** error )

Retrieve the API version from the source code.

Evaluate that the value is conformant to the established policies

Parameters

[out] error if non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: the version API encoded into integer value "1.9.3" -> 10903

◆ rs2_get_full_log_message()

const char* rs2_get_full_log_message	(	rs2_log_message const *	msg,
		rs2_error **	error
	)

Referenced by rs2::log_message::full().

◆ rs2_get_log_message_filename()

const char* rs2_get_log_message_filename	(	rs2_log_message const *	msg,
		rs2_error **	error
	)

Referenced by rs2::log_message::filename().

◆ rs2_get_log_message_line_number()

unsigned rs2_get_log_message_line_number	(	rs2_log_message const *	msg,
		rs2_error **	error
	)

Referenced by rs2::log_message::line_number().

◆ rs2_get_raw_data()

const unsigned char* rs2_get_raw_data	(	const rs2_raw_data_buffer *	buffer,
		rs2_error **	error
	)

Retrieve char array from rs2_raw_data_buffer.

Parameters

[in]	buffer	rs2_raw_data_buffer returned by rs2_send_and_receive_raw_data
[out]	error	if non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: raw data

Referenced by rs2::updatable::create_flash_backup(), rs2::pose_sensor::export_localization_map(), rs2::auto_calibrated_device::get_calibration_table(), rs2::terminal_parser::parse_command(), rs2::terminal_parser::parse_response(), rs2::auto_calibrated_device::run_on_chip_calibration(), rs2::auto_calibrated_device::run_tare_calibration(), rs2::debug_protocol::send_and_receive_raw_data(), and rs2::serializable_device::serialize_json().

◆ rs2_get_raw_data_size()

int rs2_get_raw_data_size	(	const rs2_raw_data_buffer *	buffer,
		rs2_error **	error
	)

get the size of rs2_raw_data_buffer

Parameters

[in]	buffer	pointer to rs2_raw_data_buffer returned by rs2_send_and_receive_raw_data
[out]	error	if non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: size of rs2_raw_data_buffer

Referenced by rs2::updatable::create_flash_backup(), rs2::pose_sensor::export_localization_map(), rs2::auto_calibrated_device::get_calibration_table(), rs2::terminal_parser::parse_command(), rs2::terminal_parser::parse_response(), rs2::auto_calibrated_device::run_on_chip_calibration(), rs2::auto_calibrated_device::run_tare_calibration(), rs2::debug_protocol::send_and_receive_raw_data(), and rs2::serializable_device::serialize_json().

◆ rs2_get_raw_log_message()

const char* rs2_get_raw_log_message	(	rs2_log_message const *	msg,
		rs2_error **	error
	)

Referenced by rs2::log_message::raw().

◆ rs2_get_time()

rs2_time_t rs2_get_time ( rs2_error ** error )

return the time at specific time point

Parameters

[out] error if non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns: the time at specific time point, in live and record mode it will return the system time and in playback mode it will return the recorded time

Referenced by rs2::internal::get_time().

◆ rs2_log()

void rs2_log	(	rs2_log_severity	severity,
		const char *	message,
		rs2_error **	error
	)

Add custom message into librealsense log.

Parameters

[in]	severity	The log level for the message to be written under
[in]	message	Message to be logged
[out]	error	if non-null, receives any error that occurs during this call, otherwise, errors are ignored

Referenced by rs2::log().

◆ rs2_log_to_callback()

void rs2_log_to_callback	(	rs2_log_severity	min_severity,
		rs2_log_callback_ptr	callback,
		void *	arg,
		rs2_error **	error
	)

◆ rs2_log_to_callback_cpp()

void rs2_log_to_callback_cpp	(	rs2_log_severity	min_severity,
		rs2_log_callback *	callback,
		rs2_error **	error
	)

Referenced by rs2::log_to_callback().

◆ rs2_log_to_console()

void rs2_log_to_console	(	rs2_log_severity	min_severity,
		rs2_error **	error
	)

Referenced by rs2::log_to_console().

◆ rs2_log_to_file()

void rs2_log_to_file	(	rs2_log_severity	min_severity,
		const char *	file_path,
		rs2_error **	error
	)

Referenced by rs2::log_to_file().

◆ rs2_reset_logger()

void rs2_reset_logger ( rs2_error ** error )

Referenced by rs2::reset_logger().

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Macros

Functions

Macro Definition Documentation

◆ RS2_API_BUILD_VERSION

◆ RS2_API_FULL_VERSION_STR

◆ RS2_API_MAJOR_VERSION

◆ RS2_API_MINOR_VERSION

◆ RS2_API_PATCH_VERSION

◆ RS2_API_VERSION

◆ RS2_API_VERSION_STR

◆ STRINGIFY

◆ VAR_ARG_STRING

Function Documentation

◆ rs2_delete_raw_data()

◆ rs2_depth_frame_get_distance()

◆ rs2_enable_rolling_log_file()

◆ rs2_get_api_version()

◆ rs2_get_full_log_message()

◆ rs2_get_log_message_filename()

◆ rs2_get_log_message_line_number()

◆ rs2_get_raw_data()

◆ rs2_get_raw_data_size()

◆ rs2_get_raw_log_message()

◆ rs2_get_time()

◆ rs2_log()

◆ rs2_log_to_callback()

◆ rs2_log_to_callback_cpp()

◆ rs2_log_to_console()

◆ rs2_log_to_file()

◆ rs2_reset_logger()