get_paintT_get_paintGetPaintGetPaint (Operator)
Name
get_paintT_get_paintGetPaintGetPaint
— Get the current display mode for gray values.
Signature
Description
get_paintget_paintGetPaintGetPaintGetPaint
returns the display mode for gray values in the
window. ModeModeModeModemode
is used by the operator
disp_imagedisp_imageDispImageDispImageDispImage
. get_paintget_paintGetPaintGetPaintGetPaint
is used for temporary
changes of the gray value display mode. The current value is queried,
then changed (with the operator set_paintset_paintSetPaintSetPaintSetPaint
) and finally the
old value is written back. The available modes can be viewed with
the operator query_paintquery_paintQueryPaintQueryPaintQueryPaint
. 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_paintSetPaintSetPaintSetPaint
.
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
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle
(input_control) window →
HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
ModeModeModeModemode
(output_control) string-array →
HTupleHTupleHtuple (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_paintGetPaintGetPaintGetPaint
returns 2 (H_MSG_TRUE) if the window is valid.
Otherwise an exception is raised.
Possible Predecessors
query_paintquery_paintQueryPaintQueryPaintQueryPaint
Possible Successors
set_paintset_paintSetPaintSetPaintSetPaint
,
disp_regiondisp_regionDispRegionDispRegionDispRegion
,
disp_imagedisp_imageDispImageDispImageDispImage
See also
set_paintset_paintSetPaintSetPaintSetPaint
,
query_paintquery_paintQueryPaintQueryPaintQueryPaint
,
disp_imagedisp_imageDispImageDispImageDispImage
Module
Foundation