Home > C: Programming > Function Descriptions > History back  Previous chapter  Next chapter  Print  

is_Zoom

uEye Camera Manual Version 3.80

is_Zoom

Windows_Logo

Linux_Logo

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.

Hinweis

This function is currently only supported by the USB uEye XS camera model.

This camera provides a digital zoom function with zoom factors from 1 to 16. The function always zooms in on the image center.

Input Parameters

hCam

Camera handle

nCommand

 

ZOOM_CMD_GET_CAPABILITIES

Returns the zoom functions supported by the camera.

More details

pParam: Pointer to bit mask of type UINT
In the bit mask, the status flags from ZOOM_CAPABILITY_FLAGS are returned.

nSizeOfParam: 4

ZOOM_CMD_DIGITAL_GET_LIST

Returns a list of all zoom factors supported by the camera.

More details

pParam: Pointer to a user-defined double array that returns the supported zoom factors.

nSizeOfParam: Size of the list
You can query the number of entries in the list with ZOOM_CMD_DIGITAL_GET_NUM_LIST_ENTRIES.

ZOOM_CMD_DIGITAL_GET_NUM_LIST_ENTRIES

Returns the number of entries in the list.

More details

pParam: Pointer to variable of type UINT returning the number of list entries.

nSizeOfParam: 4

ZOOM_CMD_DIGITAL_SET_VALUE

Sets a zoom factor.

More details

You can query the supported zoom factors with ZOOM_CMD_DIGITAL_GET_LIST.

pParam: Pointer to variable of type DOUBLE containing the zoom factor. For example, 4.0 means zoom with factor 4.

nSizeOfParam: 8

ZOOM_CMD_DIGITAL_GET_VALUE

Returns the current zoom factor.

More details

pParam: Pointer to variable of type DOUBLE returning the zoom factor.

nSizeOfParam: 8

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


Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!


© 2010 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com