Operator Reference

HALCON Operator Reference / Graphics / Object
ClassesClasses | | Operators

get_window_background_imageT_get_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImageget_window_background_image (Operator)

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

Signature

get_window_background_image( : BackgroundImage : WindowHandle : )

Herror T_get_window_background_image(Hobject* BackgroundImage, const Htuple WindowHandle)

void GetWindowBackgroundImage(HObject* BackgroundImage, const HTuple& WindowHandle)

HImage HWindow::GetWindowBackgroundImage() const

static void HOperatorSet.GetWindowBackgroundImage(out HObject backgroundImage, HTuple windowHandle)

HImage HWindow.GetWindowBackgroundImage()

def get_window_background_image(window_handle: HHandle) -> HObject

Description

get_window_background_imageget_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImageget_window_background_image returns a copy of the background image BackgroundImageBackgroundImageBackgroundImagebackgroundImagebackground_image set in the window WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle. 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_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackset_drawing_object_callback 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

BackgroundImageBackgroundImageBackgroundImagebackgroundImagebackground_image (output_object)  (multichannel-)image → objectHImageHObjectHObjectHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Copy of the background image.

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

Result

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

Possible Predecessors

attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindowattach_background_to_window

Possible Successors

close_windowclose_windowCloseWindowCloseWindowclose_window, detach_background_from_windowdetach_background_from_windowDetachBackgroundFromWindowDetachBackgroundFromWindowdetach_background_from_window, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window

See also

attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindowattach_background_to_window, detach_drawing_object_from_windowdetach_drawing_object_from_windowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindowdetach_drawing_object_from_window

Module

Foundation

ClassesClasses | | Operators