Legacy Document

Inside Macintosh: Imaging With QuickDraw /

Chapter 4 - Color QuickDraw / Color QuickDraw Reference

Color QuickDraw Routines / Creating and Disposing of Pixel Patterns

GetPixPat

To get a pixel pattern ('ppat') resource stored in a resource file, you can use the GetPixPat function.

FUNCTION GetPixPat (patID: Integer): PixPatHandle; 

patID

The resource ID for a resource of type 'ppat'.

DESCRIPTION

The GetPixPat function returns a handle to the pixel pattern having the resource ID you specify in the patID parameter. The GetPixPat function calls the following Resource Manager function with these parameters:

GetResource('ppat', patID);

If a 'ppat' resource with the ID that you request does not exist, the GetPixPat function returns NIL.

When you are finished with the pixel pattern, use the DisposePixPat procedure (described on page 4-82).

SPECIAL CONSIDERATIONS

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

SEE ALSO

The 'ppat' resource format is described on page 4-94. See the chapter "Resource Manager" in Inside Macintosh: More Macintosh Toolbox for more information about resources, the Resource Manager, and the GetResource function.