Operator Reference

HALCON Operator Reference / Graphics / Parameters
ClassesClasses | | Operators

get_paintT_get_paintGetPaintGetPaintget_paint (Operator)

get_paintT_get_paintGetPaintGetPaintget_paint — Get the current display mode for gray values.

Signature

get_paint( : : WindowHandle : Mode)

Herror T_get_paint(const Htuple WindowHandle, Htuple* Mode)

void GetPaint(const HTuple& WindowHandle, HTuple* Mode)

HTuple HWindow::GetPaint() const

static void HOperatorSet.GetPaint(HTuple windowHandle, out HTuple mode)

HTuple HWindow.GetPaint()

def get_paint(window_handle: HHandle) -> Sequence[Union[str, int, float]]

Description

get_paintget_paintGetPaintGetPaintget_paint returns the display mode for gray values in the window. ModeModeModemodemode is used by the operator disp_imagedisp_imageDispImageDispImagedisp_image. get_paintget_paintGetPaintGetPaintget_paint is used for temporary changes of the gray value display mode. The current value is queried, then changed (with the operator set_paintset_paintSetPaintSetPaintset_paint) and finally the old value is written back. The available modes can be viewed with the operator query_paintquery_paintQueryPaintQueryPaintquery_paint. ModeModeModemodemode is the name of the display mode. If a mode can be customized with parameters, the parameter values are passed in a tuple after the mode name. The order of values is the same as in set_paintset_paintSetPaintSetPaintset_paint.

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.

ModeModeModemodemode (output_control)  string-array → HTupleSequence[Union[str, int, float]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Name and parameter values of the current display mode.

Result

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

Possible Predecessors

query_paintquery_paintQueryPaintQueryPaintquery_paint

Possible Successors

set_paintset_paintSetPaintSetPaintset_paint, disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_imagedisp_imageDispImageDispImagedisp_image

See also

set_paintset_paintSetPaintSetPaintset_paint, query_paintquery_paintQueryPaintQueryPaintquery_paint, disp_imagedisp_imageDispImageDispImagedisp_image

Module

Foundation

ClassesClasses | | Operators