query_all_colors

query_all_colors ( : : WindowHandle : Colors )

Query all color names.

query_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_color). Before opening the first window, set_system can be used to define which and how many colors should be used. The HALCON colors are used to display regions (disp_region, disp_polygon, disp_circle, etc.). They can be defined with set_color.

Parameters

`WindowHandle` (input_control)	window `->` integer
Window_id.

`Colors` (output_control)	string-array `->` string
Color names.

Example

query_all_colors(WindowHandle,Colors) 
<interactive selection from Colors provide ActColors> >
set_system('graphic_colors',ActColors) 
open_window(0,0,1,1,'root','invisible',"',WindowHandle) 
query_color(WindowHandle,F) 
close_window(WindowHandle) 
fwrite_string(['Setting Colors: ',F]).

Result

query_all_colors always returns 2 (H_MSG_TRUE)

Parallelization Information

query_all_colors is reentrant, local, and processed without parallelization.

Possible Successors

set_system, set_color, disp_region

Module

System