Is_Setkeycolor - THORLABS DCU223x Operation Manual And Sdk

DCx Cameras

4.5.44 is_SetKeyColor

USB 2.0
Syntax
INT is_SetKeyColor (HIDS hCam, INT r, INT g, INT b)
Description
Attention
This function is obsolete and should not be used anymore. We recommend to use the
function instead (see also
198
Using is_SetKeyColor(), you define the key color for DirectDraw Overlay Surface mode.
This function can also be used to return the key color. Use the r parameter to specify the color value to be
returned. Depending on the call type, the function returns either a value reflecting the color content (0...255) or the
corresponding RGB value (0 ... 16777215).
Input parameters
hCam
r
IS_GET_KC_RED
IS_GET_KC_GREEN
IS_GET_KC_BLUE
IS_GET_KC_RGB
g
b
Return values
IS_SUCCESS
IS_NO_SUCCESS
When used with
IS_GET_KC_RGB
IS_GET_KC_RED
IS_GET_KC_GREEN
IS_GET_KC_BLUE
Related functions
is_SetDisplayMode()
is_ShowDDOverlay()
is_HideDDOverlay()
is_DisableDDOverlay()
is_EnableDDOverlay()
is_GetDDOvlSurface()
is_SetColorMode()
442
-
Obsolete functions
322
446
393
383
384
389
319
).
379
Camera handle
Red content of the key color (0...255).
The function returns the red content value.
The function returns the green content value.
The function returns the blue content value.
The function returns the RGB color.
Green content of the key color (0...255).
Blue content of the key color (0...255).
Function executed successfully
General error message
Color value
is_DirectRenderer()
© 2013 Thorlabs GmbH