query_colorT_query_colorQueryColorQueryColor (Operator)


query_colorT_query_colorQueryColorQueryColor — Query all color names displayable in the window.


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()


query_colorquery_colorQueryColorQueryColorQueryColor returns the names of all colors that are usable for region output (disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_polygondisp_polygonDispPolygonDispPolygonDispPolygon, disp_circledisp_circleDispCircleDispCircleDispCircle, etc.). On a b/w screen query_colorquery_colorQueryColorQueryColorQueryColor returns 'black' and 'white'. These two “colors” are displayable on any screen. In addition to 'black' and 'white' several gray values (e.g. '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','green','blue') and several gray values. query_all_colors(::WindowHandle:Colors )query_all_colors(WindowHandle,Colors )QueryAllColors(WindowHandle,Colors )QueryAllColors(WindowHandle,Colors )QueryAllColors(WindowHandle,Colors ) returns a list of all available colors. For screens with truecolor output the same list is returned by query_colorquery_colorQueryColorQueryColorQueryColor. The list of available colors (to HALCON ) must not be confused with the list of displayable colors. For screens with truecolor 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_rgbSetRgbSetRgbSetRgb or set_hsiset_hsiSetHsiSetHsiSetHsi. 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':) must be set.

Execution Information


WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

ColorsColorsColorsColorscolors (output_control)  string-array HTupleHTupleHtuple (string) (string) (HString) (char*)

Color names.

Example (HDevelop)

fwrite_string (FileHandle, ['Displayable colors: ',Colors])


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

Possible Successors

set_colorset_colorSetColorSetColorSetColor, disp_regiondisp_regionDispRegionDispRegionDispRegion

See also

query_all_colorsquery_all_colorsQueryAllColorsQueryAllColorsQueryAllColors, set_colorset_colorSetColorSetColorSetColor, disp_regiondisp_regionDispRegionDispRegionDispRegion, open_windowopen_windowOpenWindowOpenWindowOpenWindow