is_Sharpness


USB uEye XS	USB uEye XS

Syntax

INT is_Sharpness (HIDS hCam, UINT nCommand, void *pParam, UINT nSizeOfParam)

Description

Using is_Sharpness(), you can enhance or reduce the image sharpness 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.

Hinweis

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

Input parameters

hCam

Camera handle

SHARPNESS_CMD_GET_CAPABILITIES

Returns the function modes supported by the camera.

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

•nSizeOfParam: 4

SHARPNESS_CMD_GET_VALUE

Returns the current image sharpness setting.

•pParam: Pointer to variable of type UINT returning the current value.

•nSizeOfParam: 4

SHARPNESS_CMD_GET_MIN_VALUE

Returns the minimum image sharpness value.

•pParam: Pointer to variable of type UINT returning the minimum value.

•nSizeOfParam: 4

SHARPNESS_CMD_GET_MAX_VALUE

Returns the maximum image sharpness value.

•pParam: Pointer to variable of type UINT returning the maximum value.

•nSizeOfParam: 4

SHARPNESS_CMD_GET_INCREMENT

Returns the increment for setting the image sharpness.

•pParam: Pointer to variable of type UINT returning the increment.

•nSizeOfParam: 4

SHARPNESS_CMD_GET_DEFAULT_VALUE

Returns the default value for image sharpness.

•pParam: Pointer to variable of type UINT returning the default value.

•nSizeOfParam: 4

SHARPNESS_CMD_SET_VALUE

Sets a value for image sharpness.

•pParam: Pointer to variable of type UINT that passes the value to be set.

•nSizeOfParam: 4

pParam

Pointer to a function parameter, whose function depends on nCommand.

nSizeOfParam

Size (in bytes) of the memory area to which pParam refers.

Status flags from SHARPNESS_CAPABILITY_FLAGS

SHARPNESS_CAP_INVALID	The camera does not support setting the image sharpness
SHARPNESS_CAP_SHARPNESS_SUPPORTED	The camera supports setting the image sharpness

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

•is_EdgeEnhancement()

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

For technical questions please contact you local distributor or use the support form on our website.

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