set_insert ( : : WindowHandle, Mode : )

Define the pixel output function.

set_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 procedures that honor Mode are e.g. disp_region, disp_polygon,disp_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.


Parameters

WindowHandle (input_control)
window -> integer
Window_id.

Mode (input_control)
string -> string
Name of the display function.
Default value: 'copy'
List of values: 'copy', 'xor', 'complement'


Result

set_insert returns 2 (H_MSG_TRUE) if the paramter is correct and the window is valid. Otherwise an exception handling is raised.


Parallelization Information

set_insert is reentrant, local, and processed without parallelization.


Possible Predecessors

query_insert, get_insert


Possible Successors

disp_region


See also

get_insert, query_insert


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH