get_window_background_imageT_get_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImage (Operator)

Name

get_window_background_imageT_get_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImage — Gets a copy of the background image of the HALCON window.

Signature

get_window_background_image( : BackgroundImage : WindowHandle : )

Description

get_window_background_imageget_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImageGetWindowBackgroundImage returns a copy of the background image BackgroundImageBackgroundImageBackgroundImageBackgroundImagebackgroundImage set in the window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. This operator is specially useful in cases where the user would like to perform some operations in one of the callback functions of a drawing object attached to the window. See set_drawing_object_callbackset_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackSetDrawingObjectCallback for more details.

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

BackgroundImageBackgroundImageBackgroundImageBackgroundImagebackgroundImage (output_object) (multichannel-)image → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Copy of the background image.

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

Result

If the window exists and the specified parameters are correct get_window_background_imageget_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImageGetWindowBackgroundImage returns 2 (H_MSG_TRUE). If necessary an exception is raised.