get_window_background_imageGetWindowBackgroundImageGetWindowBackgroundImageget_window_background_imageT_get_window_background_image

HALCON ScriptCpp++.NETPythonC

Short description

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

Signature

get_window_background_image( out image BackgroundImage, window WindowHandle )void GetWindowBackgroundImage( HObject* BackgroundImage, const HTuple& WindowHandle )static void HOperatorSet.GetWindowBackgroundImage( out HObject backgroundImage, HTuple windowHandle )def get_window_background_image( window_handle: HHandle ) -> HObject

Herror T_get_window_background_image( Hobject* BackgroundImage, const Htuple WindowHandle )

HImage HWindow::GetWindowBackgroundImage( ) const

HImage HWindow.GetWindowBackgroundImage( )

Description

get_window_background_imageGetWindowBackgroundImage returns a copy of the background image BackgroundImagebackgroundImagebackground_image set in the window WindowHandlewindowHandlewindow_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_callbackSetDrawingObjectCallback for more details.

Execution information

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

BackgroundImagebackgroundImagebackground_image (output_object) (multichannel-)image → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HImage (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)Hobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Copy of the background image.

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Result

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

Combinations with other operators

Combinations

Possible predecessors

attach_background_to_windowAttachBackgroundToWindow

Possible successors

close_windowCloseWindow, detach_background_from_windowDetachBackgroundFromWindow, attach_drawing_object_to_windowAttachDrawingObjectToWindow

See also

attach_background_to_windowAttachBackgroundToWindow, detach_drawing_object_from_windowDetachDrawingObjectFromWindow

Module

Foundation