is_SetColorConverter

uEye Camera Manual Version 4.92


is_SetColorConverter

Windows_Logo
Linux_Logo

USB 2.0

USB 3.0

GigE

USB 2.0

USB 3.0

GigE

Syntax

INT is_SetColorConverter (HIDS hCam, INT ColorMode, INT ConvertMode)

Description

Using is_SetColorConverter(), you can select the type of Bayer conversion for color cameras. Software conversion is done on the PC, while hardware conversion (USB 3 uEye CP/LE/ML) is done in the camera. The use of a larger filter mask results in a higher image quality, but increases the computational load. For further information, please refer to the Camera basics: Color filters chapter.

hint_info

Hardware conversion is only supported by USB 3 uEye CP/LE/ML cameras. uEye LE USB 3.1 Gen 1 does not support hardware debayering.

hint_attention

While free run mode is active, you cannot change the color conversion type. To do so, you must first stop the capturing process using is_StopLiveVideo() or set the camera to trigger mode (see is_SetExternalTrigger()).

Input parameters

hCam

Camera handle

ColorMode

Color mode for which the converter is to be set.

For a list of all available color formats and the associated input parameters, see the Appendix: Color and memory formats section.

hmtoggle_plus1ConvertMode: Conversion mode selection

Return values

IS_INVALID_COLOR_FORMAT

Parameter ColorMode invalid or not supported

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_CAPTURE_RUNNING

A capturing operation is in progress and must be terminated first.

IS_INVALID_COLOR_FORMAT

Invalid color format

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_IR_FILTER

No IR filter available

IS_NO_SUCCESS

General error message

IS_NOT_SUPPORTED

The camera model used here does not support this function or setting.

IS_OUT_OF_MEMORY

No memory could be allocated.

IS_SUCCESS

Function executed successfully

Related functions

•is_GetColorConverter()

•is_SetColorMode()

•is_Convert()

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!
For technical questions please contact your local distributor or use the support form on our website.


© 2019 IDS Imaging Development Systems GmbH
https://en.ids-imaging.com