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

is_SetColorMode

uEye Camera Manual Version 3.80

is_SetColorMode

Windows_Logo

Linux_Logo

USB 2.0

GigE

USB 2.0

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.

Hinweis

Note on obsolete parameters

The following parameters for color formats are obsolete and should no longer be used:

IS_SET_CM_RGB32
IS_SET_CM_RGB24
IS_SET_CM_RGB16
IS_SET_CM_RGB15
IS_CM_UYVY_MONO_PACKED
IS_CM_UYVY_BAYER_PACKED

Achtung

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 mode.

Hinweis

Note on USB uEye XS

The USB uEye XS performs color conversion internally and currently supports the following color formats:

IS_CM_BGR8_PACKED (software conversion from YUV camera data)
IS_CM_BGR8A_PACKED (software conversion from YUV camera data)
IS_CM_CBYCRY_PACKED

Hinweis

Note on bit depth

Color formats with a bit depth of more than 8 bits per channel are only supported by GigE uEye camera models. Using color formats with higher bit depth increases the bandwidth used by a camera.

Hinweis

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.

Input Parameters

hCam

Camera handle

Mode

Color mode to be set

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

IS_CM_BAYER_RG16

Raw Bayer (16), only for color cameras, LUT/gamma inactive

IS_CM_BAYER_RG12

Raw Bayer (12), only for color cameras, LUT/gamma inactive

IS_CM_BAYER_RG8

Raw Bayer (8), only for color cameras, LUT/gamma inactive

IS_CM_MONO16

Greyscale (16), for monochrome and color cameras, LUT/gamma active

IS_CM_MONO12

Greyscale (12), for monochrome and color cameras, LUT/gamma active

IS_CM_MONO8

Greyscale (8), for monochrome and color cameras, LUT/gamma active

IS_CM_SENSOR_RAW16

Raw sensor data (16), for monochrome and color cameras, LUT/gamma active. For color cameras same as IS_CM_BAYER_RG16.

IS_CM_SENSOR_RAW12

Raw sensor data (12), for monochrome and color cameras, LUT/gamma active. For color cameras same as IS_CM_BAYER_RG12.

IS_CM_SENSOR_RAW8

Raw sensor data (8), for monochrome and color cameras, LUT/gamma active. For color cameras same as IS_CM_BAYER_RG8.

IS_CM_RGB10V2_PACKED

RGB30 (10 10 10), for monochrome and color cameras, LUT/gamma active

IS_CM_RGBA8_PACKED

RGB32 (8 8 8), for monochrome and color cameras, LUT/gamma active

IS_CM_RGBY8_PACKED

RGBY (8 8 8 8), for monochrome and color cameras, LUT/gamma active

IS_CM_RGB8_PACKED

RGB24 (8 8 8), for monochrome and color cameras, LUT/gamma active

IS_CM_BGR10V2_PACKED

BGR30 (10 10 10), for monochrome and color cameras, LUT/gamma active

IS_CM_BGRA8_PACKED

BGR32 (8 8 8), for monochrome and color cameras, LUT/gamma active

IS_CM_BGR8_PACKED

BGR24 (8 8 8), for monochrome and color cameras, LUT/gamma active

IS_CM_BGRY8_PACKED

BGRY (8 8 8), for monochrome and color cameras, LUT/gamma active

IS_CM_BGR565_PACKED   

BGR16 (5 6 5), for monochrome and color cameras, LUT/gamma active

IS_CM_BGR555_PACKED   

BGR15 (5 5 5), for monochrome and color cameras, LUT/gamma active

IS_CM_UYVY_PACKED

YUV 4:2:2 (8 8), for monochrome and color cameras, LUT/gamma active

IS_CM_CBYCRY_PACKED

YCbCr 4:2:2 (8 8), for monochrome and color cameras, LUT/gamma active

IS_GET_COLOR_MODE

Returns the current setting.

Return Values

IS_SUCCESS

Function executed successfully

IS_NO_SUCCESS

General error message

Current setting when used together with
IS_GET_COLOR_MODE


Related Functions

is_SetDisplayMode()
is_SetColorConverter()
is_SetColorCorrection()
is_GetColorDepth()
is_AllocImageMem()

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