Skip to content

get_paintGetPaintGetPaintget_paintT_get_paint🔗

Short description🔗

get_paintGetPaintGetPaintget_paintT_get_paint — Get the current display mode for gray values.

Signature🔗

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

Herror T_get_paint( const Htuple WindowHandle, Htuple* Mode )

HTuple HWindow::GetPaint( ) const

HTuple HWindow.GetPaint( )

Description🔗

get_paintGetPaint returns the display mode for gray values in the window. Modemodemode is used by the operator disp_imageDispImage. get_paintGetPaint is used for temporary changes of the gray value display mode. The current value is queried, then changed (with the operator set_paintSetPaint) and finally the old value is written back. The available modes can be viewed with the operator query_paintQueryPaint. Modemodemode 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_paintSetPaint.

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 / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)Sequence[Union[str, int, float]]Htuple (char* / Hlong / double)

Name and parameter values of the current display mode.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

query_paintQueryPaint

Possible successors

set_paintSetPaint, disp_regionDispRegion, disp_imageDispImage

See also

set_paintSetPaint, query_paintQueryPaint, disp_imageDispImage

Module🔗

Foundation