get-shape-box

Arguments: window-or-screen draw-fn erase-fn &optional scroll-p cursor first-corner

Similar to get-box, except that draw-fn is called each time the shape is to be drawn and erase-fn each time it is to be erased. draw-fn and erase-fn must be functions (function objects or function names, typically symbols) that accept two arguments: the window-or-screen and the current box. When they are called, the stream brush will be set to one pixel-width black, the stream paint operation to po-xor. Thus, drawing the shape twice will suffice.

(get-box s) is equivalent to (get-shape-box s #'draw-box #'draw-box).

window-or-screen should be a window or the screen. The screen is the value returned by (screen *system*). See screen and *system*.

If scroll-p is true, the window (identified by window-or-screen) will be scrolled if the cursor moves outside it.

Note that the resulting box may be destructively modified later by the system, so if you want to keep it around, you should make a copy of it.

See also nget-shape-box.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.