Operator Reference

HALCON Operator Reference / Graphics / Object
ClassesClasses | | Operators

detach_background_from_windowT_detach_background_from_windowDetachBackgroundFromWindowDetachBackgroundFromWindowdetach_background_from_window (Operator)

detach_background_from_windowT_detach_background_from_windowDetachBackgroundFromWindowDetachBackgroundFromWindowdetach_background_from_window — Detach the background image from a HALCON window.

Signature

detach_background_from_window( : : WindowHandle : )

Herror T_detach_background_from_window(const Htuple WindowHandle)

void DetachBackgroundFromWindow(const HTuple& WindowHandle)

void HWindow::DetachBackgroundFromWindow() const

static void HDrawingObject::DetachBackgroundFromWindow(const HWindow& WindowHandle)

static void HOperatorSet.DetachBackgroundFromWindow(HTuple windowHandle)

void HWindow.DetachBackgroundFromWindow()

static void HDrawingObject.DetachBackgroundFromWindow(HWindow windowHandle)

def detach_background_from_window(window_handle: HHandle) -> None

Description

This operator detaches the background image that was previously attached with attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindowattach_background_to_window from the HALCON window defined in WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle. Thus the background of the window will be cleared.

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

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

Window handle.

Result

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

Possible Predecessors

attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindowattach_background_to_window

Module

Foundation

ClassesClasses | | Operators