copy-to-stream

Copies a pixmap object or a cursor object to
stream. stream should be a
cg-stream. This function replaces
the older function copy-pixels-to-stream, which
required the use of separate texture and texture-info objects.

If from-box-or-nil is a box, this function copies
the from-box-or-nil portion of
pixmap-or-cursor to the
to-box-or-position portion of
stream, using a particular pixel-combination
mode. If from-box-or-nil is nil, the whole pixmap or cursor is copied.

If to-box-or-position is a box, the
pixmap-or-cursor is
copied to that box and is stretched (if necessary) as with
copy-pixels-to-stream. If
to-box-or-position is a position, then the pixmap
or cursor is copied without stretching so its upper left corner is at the
position. If to-box-or-position is
nil (the default), then
the pixmap or cursor is copied without stretching to position 0,0 of
stream.

Instead of passing a pixmap object, a cursor object, pixmap handle, or
a symbol bound to either a pixmap, cursor, or pixmap handle may be
passed. copy-to-stream will not work on a
cursor object if calling texture on it returns nil, as is the case with several cursors supplied by
the operating system, because Common Graphics does not have the pixel
array to copy.

To fill an area by tiling a pixmap rather than by stretching it, call
replicate-pixmap instead.

GTK Note

If the pixmap has a mask and a call to copy-to-stream stretches the pixmap, then the
masking will not be done correctly. We don't know whether we will
find a reasonable way to make this work in the future.

Copyright (c) 1998-2012, Franz Inc. Oakland, CA., USA. All rights reserved.Documentation for Allegro CL version 9.0. This page was not revised from the 8.2 page.Created 2012.5.30.