replicate-pixmap

Arguments: stream pixmap to-box &key (mode po-replace) (offset-x 0) (offset-y 0)

Fills a rectangular area with a pixmap by tiling the pixmap as needed when the area to be filled is wider or taller than the pixmap itself.

stream is a graphical-stream on which the pixmap will be drawn.

pixmap is a pixmap object. See cg-pixmaps.htm for an overview of pixmaps.

to-box is a box, as created with make-box, that specifies the area of the stream to be filled.

mode may be any value that is valid as the paint-operation of a stream. The default is the value of po-replace.

offset-x and offset-y are integers that specify how to align the pixmap with the left and top sides of the filled area. By default they are zero, which will align the left and top of the pixmap image with the left and top edges of the filled area. Otherwise the tiled pixmap images will be shifted leftward by offset-x and upward by offset-y, clipping off part of the pixmap at the left and top sides of the filled area.

To fill an area by stretching a pixmap rather than by tiling it, call copy-to-stream instead, passing a box as the to-box-or-position argument.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page is new in the 8.2 release.
Created 2016.6.21.