THORLABS DCU22 Series User Manual

333SDK (Software development Kit)
© 2010 Thorlabs
7.5.15
is_SetKeyColor
USB 2.0
-
Syntax
INT is_SetKeyColor (HIDS hCam, INT r, INT g, INT b)
Description
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 colour for DirectDraw Overlay Surface mode.
This function can also be used to return the key colour. Use the r parameter to specify the colour
value to be returned. Depending on the call type, the function returns either a value reflecting the
colour content (0...255) or the corresponding RGB value (0 ... 16777215).
Input Parameters
hCam
Camera handle
r
Red content of the key colour (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 colour.
g
Green content of the key colour (0...255).
b
Blue content of the key colour (0...255).
Return Values
IS_SUCCESS
Function executed successfully
IS_NO_SUCCESS
General error message
Colour value when used together with
IS_GET_KC_RGB
IS_GET_KC_RED
IS_GET_KC_GREEN
IS_GET_KC_BLUE
Recommended Alternative
is_DirectRenderer()
Related Functions
is_SetDisplayMode()
is_ShowDDOverlay()
130 316
130
246
335

THORLABS DCU22 Series Specifications

General

Brand	THORLABS
Model	DCU22 Series
Category	Security Camera
Language	English