dump_window_imagedump_window_imageDumpWindowImageDumpWindowImage (Operator)

Name

dump_window_imagedump_window_imageDumpWindowImageDumpWindowImage — Write the window content in an image object.

Signature

dump_window_image( : Image : WindowHandle : )

dump_window_imagedump_window_imageDumpWindowImageDumpWindowImageDumpWindowImage writes the content of the graphics window (WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle) in an image (ImageImageImageImageimage). 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

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

Parameters

ImageImageImageImageimage (output_object) image → object (byte)

Saved image.

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window handle.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_drawset_drawSetDrawSetDrawSetDraw, set_colorset_colorSetColorSetColorSetColor, set_coloredset_coloredSetColoredSetColoredSetColored, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth, disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation

Operators