set_rgbT_set_rgbSetRgbSetRgbset_rgb (Operator)

Name

set_rgbT_set_rgbSetRgbSetRgbset_rgb — Set the color definition via RGB values.

Signature

set_rgb( : : WindowHandle, Red, Green, Blue : )

Description

set_rgbset_rgbSetRgbSetRgbset_rgb sets the output color(s) or the gray values, respectively, for region output for the window. The colors are defined with the red, green and blue components. If only one combination is passed, all output takes place in that color. If a tuple is passed, region output and output of geometric objects takes place modulo the passed colors.

For every call of an output operator, output is started with the first color. If only one object is displayed per call, it will always be displayed in the first color. This is even true for objects with multiple connection components. If multiple objects are displayed per operator call, multiple colors are used. The defined colors are used until set_colorset_colorSetColorSetColorset_color, set_rgbset_rgbSetRgbSetRgbset_rgb or set_grayset_graySetGraySetGrayset_gray is called again. The values are used by operators like disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLinedisp_line, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2disp_rectangle2, disp_arrowdisp_arrowDispArrowDispArrowdisp_arrow, etc.

Attention

If a passed color is not available, an exception is raised. If set_check(::'~color':)set_check("~color")SetCheck("~color")SetCheck("~color")set_check("~color") was called before, HALCON uses a similar color and suppresses the error.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

RedRedRedredred (input_control) integer(-array) → (integer)

Red component of the color.

Default: 255

Value range: 0 ≤ Red Red Red red red ≤ 255

GreenGreenGreengreengreen (input_control) integer(-array) → (integer)

Green component of the color.

Default: 0

Value range: 0 ≤ Green Green Green green green ≤ 255

BlueBlueBlueblueblue (input_control) integer(-array) → (integer)

Blue component of the color.

Default: 0

Value range: 0 ≤ Blue Blue Blue blue blue ≤ 255

Result

set_rgbset_rgbSetRgbSetRgbset_rgb returns 2 ( H_MSG_TRUE) if the window is valid and all passed colors are available and displayable. Otherwise an exception is raised.

Possible Successors

disp_imagedisp_imageDispImageDispImagedisp_image, disp_regiondisp_regionDispRegionDispRegiondisp_region

Alternatives

set_hsiset_hsiSetHsiSetHsiset_hsi, set_colorset_colorSetColorSetColorset_color, set_grayset_graySetGraySetGrayset_gray

Module

Foundation

Operators