get_window_background_imageget_window_background_imageGetWindowBackgroundImageget_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImage (Operator)

Name

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

Signature

Description

get_window_background_imageget_window_background_imageGetWindowBackgroundImageget_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImage returns a copy of the background image BackgroundImageBackgroundImageBackgroundImageBackgroundImageBackgroundImagebackgroundImage set in the window WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. 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_callbackSetDrawingObjectCallbackset_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallback for more details.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

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

Possible Predecessors

attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindow

Possible Successors

close_windowclose_windowCloseWindowclose_windowCloseWindowCloseWindow, detach_background_from_windowdetach_background_from_windowDetachBackgroundFromWindowdetach_background_from_windowDetachBackgroundFromWindowDetachBackgroundFromWindow, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindow

See also

attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindow, detach_drawing_object_from_windowdetach_drawing_object_from_windowDetachDrawingObjectFromWindowdetach_drawing_object_from_windowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindow

Module

Foundation