Operator Reference

HALCON Operator Reference / Graphics / Parameters

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

query_colorT_query_colorQueryColorQueryColorquery_color (Operator)

query_colorT_query_colorQueryColorQueryColorquery_color — Query all color names displayable in the window.

Signature

query_color( : : WindowHandle : Colors)

Herror T_query_color(const Htuple WindowHandle, Htuple* Colors)

void QueryColor(const HTuple& WindowHandle, HTuple* Colors)

HTuple HWindow::QueryColor() const

static void HOperatorSet.QueryColor(HTuple windowHandle, out HTuple colors)

HTuple HWindow.QueryColor()

def query_color(window_handle: HHandle) -> Sequence[str]

Description

query_colorquery_colorQueryColorQueryColorquery_color returns the names of all colors that are usable for region output (disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon, disp_circledisp_circleDispCircleDispCircledisp_circle, etc.). On a b/w screen query_colorquery_colorQueryColorQueryColorquery_color returns 'black'"black""black""black""black" and 'white'"white""white""white""white". These two “colors” are displayable on any screen. In addition to 'black'"black""black""black""black" and 'white'"white""white""white""white" several gray values (e.g., 'dim gray'"dim gray""dim gray""dim gray""dim gray") are returned on screens capable of gray values. A list of all displayable colors is returned for screens with color lookup table. The returned tuple of colors begins with b/w, followed by the three primaries ('red'"red""red""red""red",'green'"green""green""green""green",'blue'"blue""blue""blue""blue") and several gray values. query_all_colors(::WindowHandle:Colors )query_all_colors(WindowHandle,Colors )QueryAllColors(WindowHandle,Colors )QueryAllColors(WindowHandle,Colors )query_all_colors(WindowHandle,Colors ) returns a list of all available colors. For screens with true-color output the same list is returned by query_colorquery_colorQueryColorQueryColorquery_color. The list of available colors (to HALCON ) must not be confused with the list of displayable colors. For screens with true-color output the available colors are only a small subset of the displayable colors. Colors that are not directly available to HALCON can be chosen manually with set_rgbset_rgbSetRgbSetRgbset_rgb or set_hsiset_hsiSetHsiSetHsiset_hsi. If colors are chosen that are known to HALCON but cannot be displayed, HALCON can choose a similar color. To use this feature, set_check(::'~color':)set_check("~color")SetCheck("~color")SetCheck("~color")set_check("~color") must be set.

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 → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

ColorsColorsColorscolorscolors (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Color names.

Example (HDevelop)

open_window(0,0,-1,-1,'root','invisible','',WindowHandle)
query_color(WindowHandle,Colors)
close_window(WindowHandle)
fwrite_string (FileHandle, ['Displayable colors: ',Colors])

Result

query_colorquery_colorQueryColorQueryColorquery_color returns 2 ( H_MSG_TRUE) , if the window is valid. Otherwise an exception is raised.

Possible Successors

set_colorset_colorSetColorSetColorset_color, disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

query_all_colorsquery_all_colorsQueryAllColorsQueryAllColorsquery_all_colors, set_colorset_colorSetColorSetColorset_color, disp_regiondisp_regionDispRegionDispRegiondisp_region, open_windowopen_windowOpenWindowOpenWindowopen_window

Module

Foundation

---

ClassesClasses | | Operators