get_drawT_get_drawGetDrawGetDraw (Operator)

Name

get_drawT_get_drawGetDrawGetDraw — Get the current region fill mode.

Signature

get_draw( : : WindowHandle : Mode)

Description

get_drawget_drawGetDrawGetDrawGetDraw returns the region fill mode of the output window. It is used by operators as disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_circledisp_circleDispCircleDispCircleDispCircle, disp_arrowdisp_arrowDispArrowDispArrowDispArrow, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2DispRectangle2 etc. The region fill mode is set with set_drawset_drawSetDrawSetDrawSetDraw.

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 → (handle)

Window handle.

ModeModeModeModemode (output_control) string → (string)

Current region fill mode.

Result

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

Possible Successors

set_drawset_drawSetDrawSetDrawSetDraw, disp_regiondisp_regionDispRegionDispRegionDispRegion

See also

set_drawset_drawSetDrawSetDrawSetDraw, disp_regiondisp_regionDispRegionDispRegionDispRegion, set_paintset_paintSetPaintSetPaintSetPaint

Module

Foundation