IDS Software Suite 4.96.1
 |
 |
|---|---|
USB uEye XS |
USB uEye XS |
Syntax
INT is_Saturation (HIDS hCam, UINT nCommand, void *pParam, UINT nSizeOfParam)
Description
Using is_Saturation(), you can enhance or reduce the color saturation if supported by your uEye model.
The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the nSizeOfParam input parameter.
|
This function is currently supported by the following camera models: •UI-1007XS |
Input parameters
hCam |
Camera handle |
pParam |
Pointer to a function parameter; which function parameter is referred to here depends on nCommand. |
nSizeOfParam |
Size (in bytes) of the memory area to which pParam refers. |
Status flags from SATURATION_CAPABILITY_FLAGS
SATURATION_CAP_INVALID |
The camera does not support setting the color saturation |
SATURATION_CAP_SATURATION_SUPPORTED |
The camera supports setting the color saturation |
Return values
IS_CANT_COMMUNICATE_WITH_DRIVER |
Communication with the driver failed because no driver has been loaded. |
IS_CANT_OPEN_DEVICE |
An attempt to initialize or select the camera failed (no camera connected or initialization error). |
IS_INVALID_CAMERA_HANDLE |
Invalid camera handle |
IS_INVALID_PARAMETER |
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. |
IS_IO_REQUEST_FAILED |
An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match. |
IS_NO_SUCCESS |
General error message |
IS_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
IS_NULL_POINTER |
Invalid array |
IS_SUCCESS |
Function executed successfully |
Related functions
