IDS Software Suite 4.96.1
 |
 |
|---|---|
USB 2.0 USB 3.x GigE |
USB 2.0 USB 3.x GigE |
Syntax
INT is_SetColorMode (HIDS hCam, INT Mode)
Description
is_SetColorMode() sets the color mode to be used when image data are saved or displayed by the graphics card. For this purpose, the allocated image memory must be large enough to accommodate the data with the selected color mode. When images are transferred directly to the graphics card memory, make sure that the display settings match the color mode settings. Otherwise, the images will be displayed with altered colors or are not clearly visible.
|
Note on display modes This function is only supported in the bitmap (DIB) display mode. Use the is_SetDisplayMode() function to display other color formats in Direct3D or OpenGL mode. |
UI-1007XS color formats
The UI-1007XS performs color conversion internally and currently supports the following color formats:
•IS_CM_BGR8_PACKED
•IS_CM_BGRA8_PACKED
•IS_CM_CBYCRY_PACKED
•IS_CM_JPEG
|
Note on bit depth Color formats with a bit depth of more than 8 bits per channel are only supported by the following models: •GigE uEye series •uEye USB 3.1 series •USB 3 uEye series •USB 2.0 models with rev. 3 Using color formats with higher bit depth increases the bandwidth used by a camera. |
|
Note on RGB15/16 For the RGB16 and RGB15 data formats, the MSBs of the internal 8-bit R, G and B colors are used. |
|
The following color formats are currently not supported by GigE uEye cameras: •IS_CM_SENSOR_RAW10 •IS_CM_MONO10 •IS_CM_RGB10_UNPACKED •IS_CM_BGR10_UNPACKED |
Input parameters
hCam |
Camera handle |
||
|
|||
Return values
When used together with |
Current setting |
IS_GET_BITS_PER_PIXEL |
Number of bits per pixel of the currently set color mode |
IS_CANT_COMMUNICATE_WITH_DRIVER |
Communication with the driver failed because no driver has been loaded. |
IS_CAPTURE_RUNNING |
A capturing operation is in progress and must be terminated first. |
IS_INVALID_CAMERA_TYPE |
The camera type defined in the .ini file does not match the current camera model. |
IS_INVALID_COLOR_FORMAT |
Invalid color format |
IS_INVALID_CAMERA_HANDLE |
Invalid camera handle |
IS_INVALID_MODE |
Camera is in standby mode, function not allowed |
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_CALIBRATED |
The camera does not contain any calibration data. |
IS_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
IS_NULL_POINTER |
Invalid array |
IS_OUT_OF_MEMORY |
No memory could be allocated. |
IS_SUCCESS |
Function executed successfully |
IS_TIMED_OUT |
A timeout occurred. An image capturing process could not be terminated within the allowable period. |
Related functions
The following parameters for color formats are obsolete. Only the new parameters should be used:
Old parameter |
New parameter |
|---|---|
IS_SET_CM_RGB32 |
IS_CM_BGRA8_PACKED |
IS_SET_CM_RGB24 |
IS_CM_BGR8_PACKED |
IS_SET_CM_RGB16 |
IS_CM_BGR565_PACKED |
IS_SET_CM_RGB15 IS_CM_BGR555_PACKED |
IS_CM_BGR5_PACKED |
IS_SET_CM_Y8 |
IS_CM_MONO8 |
IS_SET_CM_BAYER IS_CM_BAYER_RG8 |
IS_CM_SENSOR_RAW8 |
IS_SET_CM_UYVY |
IS_CM_UYVY_PACKED |
IS_SET_CM_UYVY_MONO |
IS_CM_UYVY_MONO_PACKED |
IS_SET_CM_UYVY_BAYER |
IS_CM_UYVY_BAYER_PACKED |
IS_SET_CM_CBYCRY |
IS_CM_CBYCRY_PACKED |
IS_SET_CM_RGBY |
IS_CM_BGRY8_PACKED |
IS_SET_CM_RGB30 IS_CM_BGR10V2_PACKED |
IS_CM_BGR10_PACKED |
IS_CM_RGB10V2_PACKED |
IS_CM_RGB10_PACKED |
IS_SET_CM_Y12 |
IS_CM_MONO12 |
IS_SET_CM_BAYER12 IS_CM_BAYER_RG12 |
IS_CM_SENSOR_RAW12 |
IS_SET_CM_Y16 |
IS_CM_MONO16 |
IS_SET_CM_BAYER16 IS_CM_BAYER_RG16 |
IS_CM_SENSOR_RAW16 |
IS_CM_RGB12_PACKED |
IS_CM_RGB12_UNPACKED |
IS_CM_RGBA12_PACKED |
IS_CM_RGBA12_UNPACKED |
IS_CM_BGR12_PACKED |
IS_CM_BGR12_UNPACKED |
IS_CM_BGRA12_PACKED |
IS_CM_BGRA12_UNPACKED |
