Skip to content

get_drawGetDrawGetDrawget_drawT_get_draw🔗

Short description🔗

get_drawGetDrawGetDrawget_drawT_get_draw — Get the current region fill mode.

Signature🔗

get_draw( window WindowHandle, out string Mode )void GetDraw( const HTuple& WindowHandle, HTuple* Mode )static void HOperatorSet.GetDraw( HTuple windowHandle, out HTuple mode )def get_draw( window_handle: HHandle ) -> str

Herror T_get_draw( const Htuple WindowHandle, Htuple* Mode )

HString HWindow::GetDraw( ) const

string HWindow.GetDraw( )

Description🔗

get_drawGetDraw returns the region fill mode of the output window. It is used by operators as disp_regionDispRegion, disp_circleDispCircle, disp_arrowDispArrow, disp_rectangle1DispRectangle1, disp_rectangle2DispRectangle2 etc. The region fill mode is set with set_drawSetDraw.

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 → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Current region fill mode.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

set_drawSetDraw, disp_regionDispRegion

See also

set_drawSetDraw, disp_regionDispRegion, set_paintSetPaint

Module🔗

Foundation