attach_background_to_window — Attach a background image to a HALCON window.
This operator attaches the background image passed in
to a HALCON window defined in
WindowHandle. The input image is
copied. Thus it can be freed safely.
The background image is instantly displayed in the HALCON window
attach_background_to_window. All HALCON objects
that were previously displayed in the window will still be displayed
when calling this operator. Thus the previous window content will
not be overwritten.
The window contents are displayed in the following order: first the
background image, then HALCON objects, and finally the drawing objects.
Thus, the drawing object is displayed always on top.
Note that the window will be redrawn for each user interaction within
the window and each call of
set_part. HALCON objects can be
deleted from the window with
The background image can be removed from the window with the
Note that using any synchronous operator which actively probe the event
read_char, will conflict with the
interaction with the drawing objects. In case the state of the cursor has to
be read, please refer to the documentation of your framework of choice for an
appropriate, non-invasive alternative.
Furthermore, the event based functionality should not be used together with
the former blocking operators
draw_circle. They conflict with the event based functionality, since
they actively fetch all events sent to the HALCON window.
→object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)
If the window exists and the specified parameters are correct
attach_background_to_window returns 2 (H_MSG_TRUE). If necessary an exception