dump_window_imageT_dump_window_imageDumpWindowImageDumpWindowImagedump_window_image (Operator)

Name

dump_window_imageT_dump_window_imageDumpWindowImageDumpWindowImagedump_window_image — Write the window content in an image object.

Signature

dump_window_image( : Image : WindowHandle : )

Herror T_dump_window_image(Hobject* Image, const Htuple WindowHandle)

void DumpWindowImage(HObject* Image, const HTuple& WindowHandle)

void HImage::DumpWindowImage(const HWindow& WindowHandle)

HImage HWindow::DumpWindowImage() const

static void HOperatorSet.DumpWindowImage(out HObject image, HTuple windowHandle)

void HImage.DumpWindowImage(HWindow windowHandle)

HImage HWindow.DumpWindowImage()

def dump_window_image(window_handle: HHandle) -> HObject

Description

dump_window_imagedump_window_imageDumpWindowImageDumpWindowImageDumpWindowImagedump_window_image writes the content of the graphics window (WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle) in an image (ImageImageImageImageimageimage). To transform gray values the current color table of the window is used.

Attention

Under Unix-like systems, the graphics window must be completely visible on the root window, because otherwise the contents of the window cannot be read due to limitations in X Windows.

Execution Information

Parameters

ImageImageImageImageimageimage (output_object)  image objectHImageHObjectHImageHobject * (byte)

Saved image.

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

Result

If the window is valid dump_window_imagedump_window_imageDumpWindowImageDumpWindowImageDumpWindowImagedump_window_image returns 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window, set_drawset_drawSetDrawSetDrawSetDrawset_draw, set_colorset_colorSetColorSetColorSetColorset_color, set_coloredset_coloredSetColoredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidthset_line_width, disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region

See also

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window, set_systemset_systemSetSystemSetSystemSetSystemset_system, dump_windowdump_windowDumpWindowDumpWindowDumpWindowdump_window

Module

Foundation