query_paintQueryPaintQueryPaintquery_paintT_query_paint

HALCON ScriptCpp++.NETPythonC

Short description

query_paintQueryPaintQueryPaintquery_paintT_query_paint — Query the gray value display modes.

Signature

query_paint( window WindowHandle, out string Mode )void QueryPaint( const HTuple& WindowHandle, HTuple* Mode )static void HOperatorSet.QueryPaint( HTuple windowHandle, out HTuple mode )def query_paint( window_handle: HHandle ) -> Sequence[str]

Herror T_query_paint( const Htuple WindowHandle, Htuple* Mode )

HTuple HWindow::QueryPaint( ) const

HTuple HWindow.QueryPaint( )

Description

query_paintQueryPaint returns the names of all gray value display modes (e.g., ‘gray’, ‘3d_plot’, etc.) for the output window. These modes are used by set_paintSetPaint. query_paintQueryPaint only returns the names of the display values, not the additional parameters that may be necessary for some modes.

Execution information

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

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Modemodemode (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Gray value display mode names.

Result

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

Combinations with other operators

Combinations

Possible successors

get_paintGetPaint, set_paintSetPaint, disp_imageDispImage

See also

set_paintSetPaint, get_paintGetPaint, disp_imageDispImage

Module

Foundation