Raytrix RayCam SDK  v2.1.0
Namespaces | Data Structures | Typedefs | Functions
Rx::RayCam Namespace Reference

Namespaces

 EBinningMode
 Defines the binning modes.
 
 ECallbackMode
 Defines the callback modes.
 
 ECamCompressionMode
 Defines the different trigger modes.
 
 ECamProperty
 Defines the properties that can be used to configure the camera. The following pattern indicates the usage of each property.
 
 ECamTriggerMode
 Defines the different trigger modes.
 
 ECamVideoMode
 Defines the different video modes. The enum order is: "video description"_"zoom level"_"bit depth"
 
 EDenoiseMode
 Defines the different denoise modes.
 
 EDriverProperty
 Defines the properties that can be used to configure the driver.
 
 EImageFormat
 Defines the different image formats.
 
 EImageTransferMode
 Defines the TransferMode for the Images received via the Callback function.
 
 EOisMode
 Defines the different OIS modes.
 
 EStatusMessage
 
 EStatusMessageSource
 
 EWhiteImageStatus
 Defines the status of the received image.
 

Data Structures

class  IDevice
 This class represents a camera. To use the camera in streaming mode: More...
 
class  IDriver
 Driver class initializes the driver and checks for connected and valid devices. You can search for devices, create or delete devices. More...
 

Typedefs

typedef void(__cdecl * TCallbackFunction) (void *callBackOwner, unsigned int iWidth, unsigned int iHeight, unsigned int iPixelFormat, unsigned int iDataFormat, void *pDataPtr)
 This is the callback functions which returns the captured images. More...
 
typedef void(__cdecl * TCallbackFunctionExtended) (void *callBackOwner, unsigned int iWidth, unsigned int iHeight, unsigned int iPixelFormat, unsigned int iDataFormat, void *pDataPtr, IImageProperty *pImageData)
 This is the callback functions which returns the captured images. More...
 
typedef void(__cdecl * TCallbackFunctionPnpConnect) (void *callBackOwner, IDevice *newDevice)
 Defines a callback function for new devices. More...
 
typedef void(__cdecl * TCallbackFunctionPnpDisconnect) (void *callBackOwner, IDevice *removedDevice)
 Defines a callback function for removed devices. More...
 
typedef void(__cdecl * TErrorCallback) (void *callBackOwner, Rx::Interop::Runtime31::IException &ex, Rx::RayCam::IDevice *throwingDevice)
 This is the error callback function. More...
 

Functions

DLL_API void AddInfoLogMessage (int iInfoLevel, std::string sMsg)
 Adds an information log message. More...
 
DLL_API void AddStatusMessageHandler (TStatusMessageCallback pFunc, void *pvContext)
 Registers a status message callback Function. This function will be called when a new Status Message is fired. More...
 
DLL_API Rx::RayCam::IDriverCreateDriver (void)
 Creates the driver object. The default order to create a camera would be: More...
 
DLL_API void ReleaseDriver (void)
 Releases and cleans up the driver and disconnects all attached cameras. More...
 
DLL_API void RemoveStatusMessageHandler (TStatusMessageCallback pFunc, void *pvContext)
 Removes a registered message callback function. More...
 
DLL_API void SetInfoLogLevel (int iErrorLevel)
 Set the Info log Level. More...
 

Typedef Documentation

typedef void(__cdecl * Rx::RayCam::TCallbackFunction) (void *callBackOwner, unsigned int iWidth, unsigned int iHeight, unsigned int iPixelFormat, unsigned int iDataFormat, void *pDataPtr)

This is the callback functions which returns the captured images.

typedef void(__cdecl * Rx::RayCam::TCallbackFunctionExtended) (void *callBackOwner, unsigned int iWidth, unsigned int iHeight, unsigned int iPixelFormat, unsigned int iDataFormat, void *pDataPtr, IImageProperty *pImageData)

This is the callback functions which returns the captured images.

typedef void(__cdecl * Rx::RayCam::TCallbackFunctionPnpConnect) (void *callBackOwner, IDevice *newDevice)

Defines a callback function for new devices.

typedef void(__cdecl * Rx::RayCam::TCallbackFunctionPnpDisconnect) (void *callBackOwner, IDevice *removedDevice)

Defines a callback function for removed devices.

typedef void(__cdecl * Rx::RayCam::TErrorCallback) (void *callBackOwner, Rx::Interop::Runtime31::IException &ex, Rx::RayCam::IDevice *throwingDevice)

This is the error callback function.

Function Documentation

DLL_API void Rx::RayCam::AddInfoLogMessage ( int  iInfoLevel,
std::string  sMsg 
)

Adds an information log message.

Attention
There is no need to call this function. It's only for debugging.
Parameters
iInfoLevelZero-based index of the information level.
sMsgThe message.
DLL_API void Rx::RayCam::AddStatusMessageHandler ( TStatusMessageCallback  pFunc,
void *  pvContext 
)

Registers a status message callback Function. This function will be called when a new Status Message is fired.

Parameters
pFuncThe callback function.
[in]pvContextA Context Pointer which is forwarded to the callback function call.
DLL_API Rx::RayCam::IDriver* Rx::RayCam::CreateDriver ( void  )

Creates the driver object. The default order to create a camera would be:

  1. Call Rx::RayCam::IDriver::InitDriver() on the Rx::RayCam::IDriver object. 2. Call Rx::RayCam::IDriver::DiscoverDevices() to get the number of connected devices. 3. Call Rx::RayCam::IDriver::CreateDevice() with the index of the device that should be opened.
Returns
The new driver.
DLL_API void Rx::RayCam::ReleaseDriver ( void  )

Releases and cleans up the driver and disconnects all attached cameras.

DLL_API void Rx::RayCam::RemoveStatusMessageHandler ( TStatusMessageCallback  pFunc,
void *  pvContext 
)

Removes a registered message callback function.

Parameters
pFuncThe function.
[in]pvContextIf non-null, context for the pv.
DLL_API void Rx::RayCam::SetInfoLogLevel ( int  iErrorLevel)

Set the Info log Level.

Default level is 0 Extended info level is 1 Full info output is 2.

Attention
There is no need to call this function. It's only for debugging.
Parameters
iErrorLevelZero-based index of the error level.