Arguments: stream &key box
Creates and returns a pixmap that is a copy of the image that is
currently displayed in some rectangular area of the screen. Stream may
be either the screen itself or a window. If box is nil, then the area of the screen that is covered by
the entire interior of stream is copied; otherwise box should be a box
that specifies a portion of the page (scrollable canvas) of stream, to
indicate the area of the screen to copy.
Note that the image copied is whatever appears on the screen at that moment; if other windows are covering stream then whatever covers the specified area of stream is what is copied. Therefore, when passing a window (rather than the screen) to get-pixmap, an application typically will first ensure that the window being copied is not covered by other windows, and that the desired part of the window's page is currently scrolled into the window.
An exception to the above is that if stream is either a
bitmap-pane or bitmap-window, then
the image is copied from the memory bitmap of the bitmap-pane rather
than from the screen. If box is nil, then the
entire page of the bitmap-pane is copied; otherwise box should specify
the portion of the bitmap-pane's page to copy.
get-pixmap is functionally equivalent to the older function get-texture (called get-pixels in earlier releases), except that it returns the new higher-level pixmap object rather than separate texture and texture-info objects, and the optional texture and texture-info parameters are not present on get-pixmap (to avoid consing these arguments).
See also get-screen-pixmap.
Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.
The documentation is described in introduction.htm and the index is in index.htm.
Copyright (c) 1998-2000, Franz Inc. Berkeley, CA., USA. All rights reserved.
Created 2000.10.5.