![]() |
Raytrix RayCam SDK
v2.1.0
|
Defines the properties that can be used to configure the camera. The following pattern indicates the usage of each property. More...
Defines the properties that can be used to configure the camera. The following pattern indicates the usage of each property.
[(datatype)(read/write access)(allowed camera state)(camera model)]
enum ECamProperty::ID |
Enumerator | |
---|---|
None |
The default status. |
Exposure |
Exposure time in seconds [(double)(RW)(always)(x)]. |
Framerate |
Framerate in frames per second [(double, int)(RW)(always)(x)]. |
ImageFormat |
Changes the image format [(enum)(RW)(always)(x)]. |
Gain |
Set/get current gain factor [(int, double)(RW)(always)(x)]. |
Focus |
Changes Focus. Min value is smaller than max value [(int, double)(RW)(always)(R42)]. |
VideoMode |
Selects a video mode such as 1080p [(enum)(RW)(stopped)(R42)]. |
AutoGain |
Set/get Automatic gain adjustment [(int)(RW)(always)(x)]. |
AutoExposure |
Set/get Automatic exposure adjustment [(int)(RW)(always)(x)]. |
TransferSpeed |
Adjust the pixel transfer speed. [(double)(RW)(stopped)(R42)]. |
GlobalStart |
Write 1 to enable the global start for each frame, 0 to disable the global start [(int)(RW)(stopped)(R42)]. |
ColorGainHwRed |
Sets the color gain for red. Valid values: 0 to 3.99609375, default = 1 [(double, int)(RW)(always)(R42)]. |
ColorGainHwGreen1 |
Sets the color gain for green1. Valid values: 0 to 3.99609375, default = 1 [(double, int)(RW)(always)(R42)]. |
ColorGainHwGreen2 |
Sets the color gain for green2. Valid values: 0 to 3.99609375, default = 1 [(double, int)(RW)(always)(R42)]. |
ColorGainHwBlue |
Sets the color gain for blue. Valid values: 0 to 3.99609375, default = 1 [(double, int)(RW)(always)(R42)]. |
OisMode |
Enables different OIS modes [(int)(RW)(always)(R42)]. |
OisPosition |
Moves OIS to XY position. Boundaries from -90 to 90 [(int)(RW)(always)(R42)]. |
Shutter |
Open or close shutter [(int)(RW)(always)(R42)]. |
TestPattern |
Enable or disable the test image generated by the camera hardware [(int)(RW)(always)(x)]. |
CallbackMode |
Sets or gets the callback mode [(enum)(RW)(stopped)(x)]. |
AddImageBufferPtr |
Adds another memory pointer to the internal queue for ECallbackMode::ExternalImageBuffer. The size of this buffer has to be equal or larger than the size returned by ECamProperty::ImageSize. [(void*, char*)(W)(always)(x)] |
ClearImageBufferPtr |
Clears all added image buffer [(int)(W)(always)(x)]. |
Width |
Gets the width of an image [(int)(R)(stopped)(x)]. |
Height |
Gets the height of an image [(int)(R)(stopped)(x)]. |
Resolution |
Gets the height of an image [(int, int)(RW)(stopped)(R42)]. |
RoiStartX |
Gets the ROI start X position [(int)(R)(always)(R42)]. |
RoiStartY |
Gets the ROI start Y position [(int)(R)(always)(R42)]. |
RoiStart |
Defines ROI start XY position [(int)(RW)(always)(R42)]. |
Binning |
Defines horizontal and vertical binning mode. Possible values can be 0, 2, 4, 8 etc. [(int)(RW)(stopped)(R42)]. |
ImageTransferMode |
Defines the Image Transfer Mode. Default Mode is via RAM. More Transfer Modes are Defined in Rx::RayCam::EImageTransferMode [(enum)(RW)(always)(x)] |
OpenGLContextHandle_Windows |
Returns a pointer to the windows HGLRC struct created by RayCamAPI [(long long)(R)(after open)(x)]. This pointer can be used to create a Shared OpenGL Context. |
DeviceContextHandle_Windows |
Returns a pointer to the windows HDC struct created by RayCamAPI [(long long)(R)(after open)(x)]. This pointer can be used to create a Shared OpenGL Context. |
FPNEnable |
Enable/disable fixed pattern noise correction [(int)(RW)(always)(x)]. |
DenoiseMode |
An enum constant representing the denoise mode option [(enum)(RW)(always)(x)]. |
DenoiseSigmaR |
An int constant representing the denoise sigma r option [(double)(RW)(always)(x)]. |
DenoiseSigmaS |
An int constant representing the denoise sigma s option [(double)(RW)(always)(x)]. |
HighDynamicRange |
Enable or disable HDR mode [(int)(RW)(always)(x)]. |
BurstMode |
Enable or disable the burst mode. Set value to 5 to get a burst of 5 images [(int)(RW)(always)(x)]. |
GammaCorrectionSW |
Get/Set the SW gamma correction Value [(double)(RW)(always)(x)]. |
ColorGainSWRed |
Get/Set the GPU red gain Value [(double)(RW)(always)(x)]. |
ColorGainSWGreen |
Get/Set the GPU green gain Value [(double)(RW)(always)(x)]. |
ColorGainSWBlue |
Get/Set the GPU blue gain Value [(double)(RW)(always)(x)]. |
StrobeOn | |
StrobeLength1 | |
StrobeLength2 | |
StrobeDelay1 | |
StrobeDelay2 | |
TimeoutDevignettingWhiteBalance | |
Optics |
Check for integrated optic [(int)(R)(always)(R42)]. |
SharpeningSW |
Enable Software Sharpening [(int)(RW)(always)(x)]. |
InternalFrameBufferCount |
Defines internal image buffer size, default is 5 [(int)(RW)(stopped)(Rx)]. |
UsbReceiveBufferMultiplier |
Defines USB receive buffer multiplier, entered values will be rounded up to the next power of 2, default is 1024. Values below 1024 can cause serious trouble during USB transfer! [(int)(RW)(stopped)(Rx)]. |
MechanicalShutter |
Write 1 to enable the mechanical shutter for each frame, 0 to disable the mechanical shutter. Enable GlobalStart to use this option. [(int)(RW)(stopped)(R42)]. |
FrameStartDelay |
The time in µs between the trigger signal and frame start event. [(double)(RO)(always)(R42)]. |
Unpack1012Bit |
Enable unpacking of 10 and 12 bit images to 16 bit. |
BinningMode |
Set the binning mode. The available modes are enumerated in EBinningMode.h [(int)(RW)(always)(R42)]. |
Zoom |
Sets the zoom factor by changing resolution and binning factors. The output image dimensions will stay the same when zoomed. Zooming is only available is a video/image configuration with binning is selected. [(int)(RW)(always)(R42)]. |
Name |
The camera name [(char*)(R)(always)(x)]. |
Serialnumber |
The unique serial number of the camera [(char*)(R)(always)(x)]. |
Type |
Returns camera type [(int)(R)(always)(x)]. |
Color |
A value !=0 represents color [(int)(R)(always)(x)]. |
Bitdepth |
Gets or sets the bit depth of an image, values can be 8, 10 or 12 [(int)(RW)(always)(R42)]. |
BayerPattern |
Representing bayer pattern Rx::RayCam::EBayerPattern::ID [(enum)(R)(always)(x)]. |
ImageSize |
Gets the image size [(int)(R)(always)(x)]. |
DataFormat |
Gets the data format of the image [(enum)(R)(always)(x)]. |
IsRunning |
Checks, if the camera is still running [(int)(R)(always)(x)]. |
TempSensor |
Temperature of the sensor in Celsius [(double)(R)(always)(x)]. |
TempChip |
Temperature of the chip in Celsius [(double)(R)(always)(x)]. |
VersionCamFirmware |
Returns the current camera firmware version [(char*)(R)(always)(x)]. |
ColorGainHW |
Only used for HasProperty to check for HW Gain capabilities [(int)(R)(always)(x)]. |
GPUCapable |
Returns true if the system is able to process images on the GPU [(int)(R)(always)(x)]. |
GoodFrames |
Returns the number of good frames for the current/last run [(long)(R)(always)(x)]. |
BadFrames |
Returns the number of bad frames for the current/last run [(long)(R)(always)(x)]. |
TotalFrames |
Returns the number of all frames for the current/last run [(long)(R)(always)(x)]. |
ExposureStepSize |
Returns minimal step size for exposure time changes [(double)(R)(always)(x)]. |
Gyroscope |
Returns x and y values for the gyroscope [(int, int)(R)(always)(R42)]. |
GyroscopeX |
Returns x value for the gyroscope [(int)(R)(always)(R42)]. |
GyroscopeY |
Returns x value for the gyroscope [(int)(R)(always)(R42)]. |