set_insertset_insertset_insertSetInsertSetInsert (Operator)

Name

set_insertset_insertset_insertSetInsertSetInsert — Define the pixel output function.

Signature

Description

set_insertset_insertset_insertSetInsertSetInsert 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_regiondisp_regionDispRegionDispRegion, disp_polygondisp_polygondisp_polygonDispPolygonDispPolygon,disp_circledisp_circledisp_circleDispCircleDispCircle.

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.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
• Processed without parallelization.

Parameters

Result

set_insertset_insertset_insertSetInsertSetInsert returns 2 (H_MSG_TRUE) if the parameter is correct and the window is valid. Otherwise an exception is raised.

Possible Predecessors

query_insertquery_insertquery_insertQueryInsertQueryInsert, get_insertget_insertget_insertGetInsertGetInsert

Possible Successors

disp_regiondisp_regiondisp_regionDispRegionDispRegion

See also

get_insertget_insertget_insertGetInsertGetInsert, query_insertquery_insertquery_insertQueryInsertQueryInsert

Module

Foundation