Operator Reference

query_all_colorsT_query_all_colorsQueryAllColorsQueryAllColorsquery_all_colors (Operator)

query_all_colorsT_query_all_colorsQueryAllColorsQueryAllColorsquery_all_colors — Query all color names.

Signature

query_all_colors( : : WindowHandle : Colors)

Herror T_query_all_colors(const Htuple WindowHandle, Htuple* Colors)

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

HTuple HWindow::QueryAllColors() const

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

HTuple HWindow.QueryAllColors()

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

Description

query_all_colorsquery_all_colorsQueryAllColorsQueryAllColorsquery_all_colors returns the names of all colors that are known to HALCON. That doesn't mean that these colors are available for specific screens. On some screens there may only be a subset of colors available (see query_colorquery_colorQueryColorQueryColorquery_color). The HALCON colors are used to display regions (disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon, disp_circledisp_circleDispCircleDispCircledisp_circle, etc.). They can be defined with set_colorset_colorSetColorSetColorset_color.

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.

Result

query_all_colorsquery_all_colorsQueryAllColorsQueryAllColorsquery_all_colors always returns 2 ( H_MSG_TRUE)

Possible Successors

set_systemset_systemSetSystemSetSystemset_system, set_colorset_colorSetColorSetColorset_color, disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

query_colorquery_colorQueryColorQueryColorquery_color, set_systemset_systemSetSystemSetSystemset_system, set_colorset_colorSetColorSetColorset_color, disp_regiondisp_regionDispRegionDispRegiondisp_region, open_windowopen_windowOpenWindowOpenWindowopen_window

Module

Foundation