set_insertT_set_insertSetInsertSetInsertset_insert (Operator)
Name
set_insertT_set_insertSetInsertSetInsertset_insert
— Define the pixel output function.
Warning
set_insertset_insertSetInsertSetInsertset_insert
is obsolete and is only provided for
reasons of backward compatibility.
Signature
Description
set_insertset_insertSetInsertSetInsertset_insert
defines the function, with which pixels are
displayed in the output window. It is e.g., possible for a pixel to
overwrite the old value. In most of the cases there is a functional
relationship between old and new values.
The definition value is only valid for the valid window. Output
operators that honor ModeModeModemodemode
are
e.g., disp_regiondisp_regionDispRegionDispRegiondisp_region
,
disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon
,disp_circledisp_circleDispCircleDispCircledisp_circle
.
Possible display functions are:
- 'copy':
overwrite displayed pixels
- 'xor':
display old "xor" new pixels
- 'complement':
complement displayed pixels
There may not be all functions available, depending on the physical
display. However, “copy” is always available.
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
(input_control) string →
HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the display function.
Default:
'copy'
"copy"
"copy"
"copy"
"copy"
List of values:
'complement'"complement""complement""complement""complement", 'copy'"copy""copy""copy""copy", 'xor'"xor""xor""xor""xor"
Result
set_insertset_insertSetInsertSetInsertset_insert
returns 2 (
H_MSG_TRUE)
if the parameter is correct and
the window is valid. Otherwise an exception is raised.
Possible Predecessors
query_insertquery_insertQueryInsertQueryInsertquery_insert
,
get_insertget_insertGetInsertGetInsertget_insert
Possible Successors
disp_regiondisp_regionDispRegionDispRegiondisp_region
See also
get_insertget_insertGetInsertGetInsertget_insert
,
query_insertquery_insertQueryInsertQueryInsertquery_insert
Module
Foundation