Home > C: Programming > Function Descriptions > | History back Previous chapter Next chapter Print |
is_DeviceFeature |
uEye Camera Manual Version 3.80
is_DeviceFeature
USB 2.0 GigE |
USB 2.0 GigE |
Syntax
INT is_DeviceFeature (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)
Description
Using is_DeviceFeature() you can configure special camera functions provided by specific uEye models:
• | On UI-124x/UI524x models: Set line scan mode, see Basics: Line scan mode |
• | On UI-124x/UI524x models: Toggle between rolling and global shutter mode, see Basics: Shutter Methods |
• | On UI-1008XS (uEye XS) model: Choose the HS mode for triggered image capture, see UI-1008XS Application Notes |
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.
Input Parameters
hCam |
Camera handle |
nCommand |
|
IS_DEVICE_FEATURE_CMD_GET_SUPPORTED_FEATURES |
Returns the special functions supported by the camera (see Status Flags table). |
IS_DEVICE_FEATURE_CMD_SET_LINESCAN_MODE |
Sets the line scan mode |
IS_DEVICE_FEATURE_CMD_GET_LINESCAN_MODE |
Returns the currently set line scan mode |
IS_DEVICE_FEATURE_CMD_SET_LINESCAN_NUMBER |
Sets the scan line used for the line scan mode |
IS_DEVICE_FEATURE_CMD_GET_LINESCAN_NUMBER |
Returns the scan line used for the line scan mode |
IS_DEVICE_FEATURE_CMD_SET_SHUTTER_MODE |
Sets the shutter mode |
IS_DEVICE_FEATURE_CMD_GET_SHUTTER_MODE |
Returns the shutter mode |
IS_DEVICE_FEATURE_CMD_SET_PREFER_XS_HS_MODE |
Enables the HS mode on the uEye XS |
IS_DEVICE_FEATURE_CMD_GET_PREFER_XS_HS_MODE |
Returns if the HS mode is enabled |
IS_DEVICE_FEATURE_CMD_GET_DEFAULT_PREFER_XS_HS_MODE |
Returns the default setting for the HS mode |
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 DEVICE_FEATURE_MODE_CAPS
IS_DEVICE_FEATURE_CAP_SHUTTER_MODE_ROLLING |
Rolling shutter mode |
IS_DEVICE_FEATURE_CAP_SHUTTER_MODE_GLOBAL |
Global shutter mode |
IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_OFF |
Disable line scan mode |
IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_FAST |
Fast line scan mode |
IS_DEVICE_FEATURE_CAP_PREFER_XS_HS_MODE |
HS mode |
Return Values
IS_SUCCESS |
Function executed successfully |
IS_NO_SUCCESS |
General error message |
Code Sample
INT nSupportedFeatures; INT nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_SUPPORTED_FEATURES, (void*)&nSupportedFeatures, sizeof(nSupportedFeatures)); if (nRet == IS_SUCCESS) { if (nSupportedFeatures & IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_FAST) { // Enable line scan mode INT nLineMode = IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_FAST; INT nRet = is_DeviceFeature(m_hCam,IS_DEVICE_FEATURE_CMD_SET_LINESCAN_MODE,
// Disable line scan mode INT nLineMode = 0; nRet = is_DeviceFeature(m_hCam, IS_DEVICE_FEATURE_CMD_SET_LINESCAN_MODE, (void*)&nLineMode, sizeof(nLineMode)); }
// Return line scan mode nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LINESCAN_MODE, (void*)&nMode , sizeof(nMode)); } |