Carbon


BitMapToRegion

Header: Quickdraw.h Carbon status: Supported

Converts a bitmap or pixel map to a region.

OSErr BitMapToRegion (
     region, 
    const BitMap *bMap
);
Parameter descriptions
region

A handle to a region to hold the converted BitMap or PixMap structure. This must be a valid region handle created with the NewRgn function. The old region contents are lost.

bMap

A pointer to a BitMap or PixMap structure to be converted. If you supply a PixMap structure, its pixel depth must be 1. The BitMapToRegion function converts this structure to a region. You would generally use this region later for drawing operations.

function result

A result code.

DISCUSSION

The BitMapToRegion function converts a given BitMap or PixMap record to a region. You would generally use this region later for drawing operations. The region parameter must be a valid region handle created with the NewRgn function (described in the chapter “QuickDraw Drawing”). The old region contents are lost.

The bMap parameter may be either a BitMap or PixMap record. If you pass a PixMap record, its pixel depth must be 1.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)