Home > C: Programming > Function Descriptions > | History back Previous chapter Next chapter Print |
is_Zoom |
uEye Camera Manual Version 3.80
is_Zoom
USB uEye XS |
USB uEye XS |
Syntax
INT is_Zoom (HIDS hCam, UINT nCommand,
void *pParam,
UINT nSizeOfParam)
Description
is_Zoom() controls the zoom function of the lens or sensor (digital zoom) if supported by your camera.
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 receives 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 |
|
|
ZOOM_CMD_GET_CAPABILITIES |
Returns the zoom functions supported by the camera.
|
|
ZOOM_CMD_DIGITAL_GET_LIST |
Returns a list of all zoom factors supported by the camera.
|
|
ZOOM_CMD_DIGITAL_GET_NUM_LIST_ENTRIES |
Returns the number of entries in the list.
|
|
ZOOM_CMD_DIGITAL_SET_VALUE |
Sets a zoom factor.
|
|
ZOOM_CMD_DIGITAL_GET_VALUE |
Returns the current zoom factor.
|
|
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 ZOOM_CAPABILITY_FLAGS
ZOOM_CAP_INVALID |
The camera does not support the zoom function |
ZOOM_CAP_DIGITAL_ZOOM |
The camera supports digital zoom |
Return Values
IS_SUCCESS |
Function executed successfully |
IS_NO_SUCCESS |
General error message |