THORLABS DCU223x User Manual

© 2013 Thorlabs GmbH442
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 is_DirectRenderer()
function instead (see also Obsolete functions ).
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
Camera handle
r
Red content of the key color (0...255).
IS_GET_KC_RED
The function returns the red content value.
IS_GET_KC_GREEN
The function returns the green content value.
IS_GET_KC_BLUE
The function returns the blue content value.
IS_GET_KC_RGB
The function returns the RGB color.
g
Green content of the key color (0...255).
b
Blue content of the key color (0...255).
Return values
IS_SUCCESS
Function executed successfully
IS_NO_SUCCESS
General error message
When used with
IS_GET_KC_RGB
IS_GET_KC_RED
IS_GET_KC_GREEN
IS_GET_KC_BLUE
Color value
Related functions
is_SetDisplayMode()
is_ShowDDOverlay()
is_HideDDOverlay()
is_DisableDDOverlay()
is_EnableDDOverlay()
is_GetDDOvlSurface()
is_SetColorMode()
198 379
322
446
393
383
384
389
319

THORLABS DCU223x Specifications

General

Brand	THORLABS
Model	DCU223x
Category	Security Camera
Language	English