USB 3.0 GigE	USB 3.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:

•Enable/disable black reference columns, see uEye Cockpit: Advanced features

•Enable/disable black reference rows, see uEye Cockpit: Advanced features

The black level reference is currently supported by the following models: •UI-300x (reference rows) •UI-304x/UI-504x (reference rows) •UI-306x (reference rows) •UI-308x (reference rows) •UI-309x (reference rows) •UI-313x/UI-513x (reference rows) •UI-314x/UI-514x (reference rows) •UI-316x (reference rows) •UI-318x (reference rows) •UI-320x/UI-520x (reference rows) •UI-326x/UI-526x (reference rows) •UI-329x/UI-529x (reference rows) •UI-336x/UI-536x (reference columns) •UI-337x/UI-537x (reference columns)

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 cbSizeOfParam input parameter.

Input parameters

hCam	Camera handle
nCommand IS_DEVICE_FEATURE_CMD_GET_BLACK_REFERENCE_MODE_DEFAULT Returns the default setting for the black reference. IS_DEVICE_FEATURE_CMD_GET_BLACK_REFERENCE_MODE Returns the current setting of the black reference (Example). IS_DEVICE_FEATURE_CMD_SET_BLACK_REFERENCE_MODE Sets the settings of black reference: •IS_BLACK_REFERENCE_MODE_OFF: Disables the black level reference •IS_BLACK_REFERENCE_MODE_COLUMNS_LEFT: Enables the black level reference columns (left image side) •IS_BLACK_REFERENCE_MODE_ROWS_TOP: Enables the black level reference rows (top)
pParam	Pointer to a function parameter, whose function depends on nCommand.
cbSizeOfParam	Size (in bytes) of the memory area to which pParam refers.

Status flags from DEVICE_FEATURE_MODE_CAPS

Example

UINT nMode = 0;
 
/* Get current black reference mode */
INT nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_BLACK_REFERENCE_MODE, (void*)&nMode,
                          sizeof(nMode));
 
/* Get supported black reference mode(s) */
INT nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_SUPPORTED_BLACK_REFERENCE_MODES,
                          (void*)&nMode, sizeof(nMode));
 
/* Set the Black reference mode according to the supported mode */
if (IS_BLACK_REFERENCE_MODE_COLUMNS_LEFT == nMode)
{
  /* Enable black reference mode left columns */
  nMode = IS_BLACK_REFERENCE_MODE_COLUMNS_LEFT;
  nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_BLACK_REFERENCE_MODE, (void*)&nMode,
                          sizeof(nMode));
}
else if (IS_BLACK_REFERENCE_MODE_ROWS_TOP == nMode)
{
  /* Enable black reference mode top rows */
  nMode = IS_BLACK_REFERENCE_MODE_ROWS_TOP;
  nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_BLACK_REFERENCE_MODE, (void*)&nMode,
                          sizeof(nMode));
}