set_insertT_set_insertSetInsertSetInsert (Operator)

Name

set_insertT_set_insertSetInsertSetInsert — Define the pixel output function.

Signature

Description

set_insertset_insertSetInsertSetInsertSetInsert 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_regionDispRegionDispRegionDispRegion, disp_polygondisp_polygonDispPolygonDispPolygonDispPolygon,disp_circledisp_circleDispCircleDispCircleDispCircle.

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

Result

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

Possible Predecessors

query_insertquery_insertQueryInsertQueryInsertQueryInsert, get_insertget_insertGetInsertGetInsertGetInsert

Possible Successors

disp_regiondisp_regionDispRegionDispRegionDispRegion

See also

get_insertget_insertGetInsertGetInsertGetInsert, query_insertquery_insertQueryInsertQueryInsertQueryInsert

Module

Foundation