RVC namespace. More...

Classes
struct	ConfidenceMap

struct	CorrespondMap

struct	DepthMap
	RVC X DepthMap. More...

struct	Device
	Device struct. More...

struct	DeviceInfo
	RVC X Device info. More...

struct	Handle
	RVC Handle. More...

struct	Image
	RVC X Image object. More...

struct	ImageType
	Image Type. More...

struct	Mesh

struct	PointMap
	RVC X PointMap. More...

struct	PointMapType
	RVC X PointMap Type. More...

struct	PointMapUnit

struct	ROI
	Image ROI. More...

struct	ROIRange
	Device ROIRange. More...

struct	Size
	Image/PointMap Size. More...

struct	SystemListDeviceType
	System list Device type. More...

struct	X1
	X1 struct. More...

struct	X2
	X2 struct. More...

Typedefs
typedef uint32_t	HandleID
	Handle id 4 bytes long.

typedef void *	UserPtr

Enumerations
enum	CameraID { CameraID_NONE = 0, CameraID_0 = 1 << 0, CameraID_1 = 1 << 1, CameraID_2 = 1 << 2, CameraID_3 = 1 << 3, CameraID_Left = CameraID_0, CameraID_Right = CameraID_1, CameraID_Both = CameraID_Left \| CameraID_Right, CameraID_Extra = CameraID_2 }
	CameraID, support CameraID_Left and CameraID_Right

enum	PortType { PortType_NONE = 0, PortType_USB = 1, PortType_GIGE = 2 }
	RVC supported Camera Port type. More...

enum	NetworkType { NetworkType_DHCP = 0, NetworkType_STATIC = 1 }
	RVC supported Camera Network type. More...

enum	ProjectorColor { ProjectorColor_None = 0, ProjectorColor_Red = 1, ProjectorColor_Green = 2, ProjectorColor_Blue = 4, ProjectorColor_White = 8, ProjectorColor_ALL = ProjectorColor_Red \| ProjectorColor_Green \| ProjectorColor_Blue \| ProjectorColor_White }
	Projector color, support ProjectorColor_Red, ProjectorColor_Green, ProjectorColor_Blue, ProjectorColor_White and ProjectorColor_ALL

enum	ProtectiveCoverStatus { ProtectiveCoverStatus_Unknown = 0, ProtectiveCoverStatus_Closed = 1, ProtectiveCoverStatus_Closing = 2, ProtectiveCoverStatus_Open = 3, ProtectiveCoverStatus_Opening = 4 }
	Protective Cover Status.

enum	BalanceSelector { BalanceSelector_None = 0, BalanceSelector_Red, BalanceSelector_Green, BalanceSelector_Blue }
	White balance ratio selector, suport BalanceSelector_Red, BalanceSelector_Green and BalanceSelector_Blue

enum	NetworkDevice { NetworkDevice_LightMachine = 0, NetworkDevice_LeftCamera = 1, NetworkDevice_RightCamera = 2, NetworkDevice_ExtraCamera = 3 }
	NetworkDevie, support NetworkDevice_LightMachine, NetworkDevice_LeftCamera and NetworkDevice_RightCamera

enum	NetworkDeviceStatus_ { NetworkDeviceStatus_OK, NetworkDeviceStatus_Not_Reachable, NetworkDeviceStatus_In_Use, NetworkDeviceStatus_Conflict }
	NetworkDevieStatus, support NetworkDeviceStatus_OK, NetworkDeviceStatus_Not_Reachable, NetworkDeviceStatus_In_Use and NetworkDeviceStatus_Conflict

enum	CaptureMode { CaptureMode_Fast = 1 << 0, CaptureMode_Normal = 1 << 1, CaptureMode_Ultra = 1 << 2, CaptureMode_Robust = 1 << 3, CaptureMode_AntiInterReflection = 1 << 4, CaptureMode_SwingLineScan = 1 << 5, CaptureMode_FixedLineScan = 1 << 6, CaptureMode_LineArrayShift = 1 << 7, CaptureMode_All }
	CaptureMode, support CaptureMode_Fast, CaptureMode_Normal, CaptureMode_Ultra, CaptureMode_Robust, CaptureMode_AntiInterReflection and CaptureMode_SwingLineScan

enum	TriggerMode { TriggerMode_SoftWare = 0, TriggerMode_HardWare = 1, TriggerMode_FixedRate = 2 }
	Defines the trigger source for point cloud acquisition. More...

enum	CameraTempSelector { CameraTempSelector_Camera, CameraTempSelector_CoreBoard, CameraTempSelector_FpgaCore, CameraTempSelector_Framegrabberboard, CameraTempSelector_Sensor, CameraTempSelector_SensorBoard }

enum	SmoothnessLevel { SmoothnessLevel_Off, SmoothnessLevel_Weak, SmoothnessLevel_Normal, SmoothnessLevel_Strong }

Functions
bool	operator== (const Size &lhs, const Size &rhs)
	Compare two Image size. More...

bool	operator!= (const Size &lhs, const Size &rhs)
	Compare two Image size. More...

bool	operator== (const ROI &lhs, const ROI &rhs)
	Compare two Image ROI. More...

bool	operator!= (const ROI &lhs, const ROI &rhs)
	Compare two Image roi. More...

RVC_EXPORT int	GetLastError ()
	Get last error of RVC SDK. More...

RVC_EXPORT const char *	GetVersion ()
	Get the Version of RVC SDK. More...

RVC_EXPORT const char *	GetLastErrorMessage ()
	Get the lastest error message. The pointer to string is temporary, you need to copy data from its buffer to your buffer to prevent dangling pointer. More...

RVC_EXPORT bool	SystemInit ()
	SystemInit. More...

RVC_EXPORT bool	SystemIsInited ()
	Check system is inited or not. More...

RVC_EXPORT void	SystemShutdown ()
	SystemShutdown. More...

RVC_EXPORT int	SystemListDevices (Device pdevices, size_t size, size_t actual_size, SystemListDeviceType::Enum opt=SystemListDeviceType::All)
	List the fix number devices. More...

RVC_EXPORT Device	SystemFindDevice (const char *serialNumber)
	Return the device according to the serialNumber, if the device is valid. More...

RVC_EXPORT void	SystemSetLoggerName (const char *loggerName)
	Set the name of logger. More...

Detailed Description

RVC namespace.

Enumeration Type Documentation

◆ NetworkType

enum RVC::NetworkType

RVC supported Camera Network type.

Only valid when Camera PortType is PortType_GIGE

All support type is NetworkType_DHCP, NetworkType_STATIC

◆ PortType

enum RVC::PortType

RVC supported Camera Port type.

All support type is PortType_USB, PortType_GIGE

◆ TriggerMode

enum RVC::TriggerMode

Defines the trigger source for point cloud acquisition.

This enumeration specifies how the 3D camera initiates point cloud generation, determining whether acquisition is triggered by software (explicit function calls) or by external hardware signals.

Enumerator

TriggerMode_SoftWare

Software trigger mode.

In this mode, point clouds are generated only when explicitly requested by calling the SDK's capture functions. The application has full control over the timing of acquisition by calling either:

Capture()
GetFixedLineScanPointMap()

Note: This mode is supported by all acquisition modes.

TriggerMode_HardWare

Hardware trigger mode.

Point clouds are generated automatically in response to external hardware signals (e.g., encoder pulses, PLC outputs, or GPIO signals). The application must register a callback function to receive point cloud data asynchronously when hardware triggers occur. The fixed line scan mode should be initiated before the hardware signals begin and terminated after they cease.

Note: Hardware trigger is only supported when using FixedLineScan acquisition mode. Other modes require software trigger.

See also: SetFixedLineScanCallback

TriggerMode_FixedRate

Fixed-rate automatic trigger mode.

In this mode, the camera automatically generates point clouds at a fixed internal frequency, without requiring external hardware signals or explicit software calls for each acquisition.

The application must register a callback function to receive point cloud data asynchronously as it is generated at the predefined rate.

Note: This mode requires registration of a callback function to receive data.

See also: SetFixedLineScanCallback

Function Documentation

◆ GetLastError()

RVC_EXPORT int RVC::GetLastError ( )

Get last error of RVC SDK.

Returns: int

◆ GetLastErrorMessage()

RVC_EXPORT const char* RVC::GetLastErrorMessage ( )

Get the lastest error message. The pointer to string is temporary, you need to copy data from its buffer to your buffer to prevent dangling pointer.

Returns: string of error message

◆ GetVersion()

RVC_EXPORT const char* RVC::GetVersion ( )

Get the Version of RVC SDK.

Returns: string of version

◆ operator!=() [1/2]

bool RVC::operator!=	(	const Size &	lhs,
		const Size &	rhs
	)

inline

Compare two Image size.

Parameters

lhs	one Image Size
rhs	another Image Size

Returns: true not equal; false equal

◆ operator!=() [2/2]

bool RVC::operator!=	(	const ROI &	lhs,
		const ROI &	rhs
	)

inline

Compare two Image roi.

Parameters

lhs	one Image roi
rhs	another Image roi

Returns: true equal; false not equal

◆ operator==() [1/2]

bool RVC::operator==	(	const Size &	lhs,
		const Size &	rhs
	)

inline

Compare two Image size.

Parameters

lhs	one Image Size
rhs	another Image Size

Returns: true equal; false not equal

◆ operator==() [2/2]

bool RVC::operator==	(	const ROI &	lhs,
		const ROI &	rhs
	)

inline

Compare two Image ROI.

Parameters

lhs	one Image roi
rhs	another Image roi

Returns: true equal; false not equal

◆ SystemFindDevice()

RVC_EXPORT Device RVC::SystemFindDevice ( const char * serialNumber )

Return the device according to the serialNumber, if the device is valid.

Parameters

serialNumber Device Struct serial number

Returns: Device The serialNumber corresponding Device Struct

◆ SystemInit()

RVC_EXPORT bool RVC::SystemInit ( )

SystemInit.

Returns: true Success; false Failed

SystemInit.

◆ SystemIsInited()

RVC_EXPORT bool RVC::SystemIsInited ( )

Check system is inited or not.

Returns: true Inited; false Not Inited

Check system is inited or not.

◆ SystemListDevices()

RVC_EXPORT int RVC::SystemListDevices	(	Device *	pdevices,
		size_t	size,
		size_t *	actual_size,
		SystemListDeviceType::Enum	opt = `SystemListDeviceType::All`
	)

List the fix number devices.

Parameters

pdevices	device listed
size	desire list devices number
actual_size	actually list devices number
opt	List DeviceType All/USB/GIGE optional

Returns: int Status code

◆ SystemSetLoggerName()

RVC_EXPORT void RVC::SystemSetLoggerName ( const char * loggerName )

Set the name of logger.

Parameters

loggerName The logger name

◆ SystemShutdown()

RVC_EXPORT void RVC::SystemShutdown ( )

SystemShutdown.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ NetworkType

◆ PortType

◆ TriggerMode

Function Documentation

◆ GetLastError()

◆ GetLastErrorMessage()

◆ GetVersion()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ SystemFindDevice()

◆ SystemInit()

◆ SystemIsInited()

◆ SystemListDevices()

◆ SystemSetLoggerName()

◆ SystemShutdown()