Legacy Document

Inside Macintosh: Imaging With QuickDraw /

Chapter 3 - QuickDraw Drawing / QuickDraw Drawing Reference

Routines / Drawing Regions

FrameRgn

To draw an outline inside a region, use the FrameRgn procedure.

PROCEDURE FrameRgn (rgn:\xDDRgnHandle);

rgn

A handle to the region to frame.

DESCRIPTION

Using the current graphics port's pen pattern, pattern mode, and pen size, the FrameRgn procedure draws an outline just inside the region whose handle you pass in the rgn parameter. The outline never goes outside the region boundary. The pen location does not change.

If a region is open and being formed, the outside outline of the region being framed is mathematically added to that region's boundary.

SPECIAL CONSIDERATIONS

The FrameRgn procedure calls the routines CopyRgn, InsetRgn, and DiffRgn, so FrameRgn may temporarily use heap space that's three times the size of the original region.

The FrameRgn procedure may move or purge memory blocks in the application heap. Your application should not call this procedure at interrupt time.