Retired Documents Library

Developer

ApplicationServices Framework Reference QuickDraw Reference

Options
Deployment Target:

On This Page
Language:

QuickDraw Reference (Legacy)

QuickDraw is the legacy 2D drawing engine for Macintosh computers. QuickDraw provides routines for drawing, manipulating, and displaying graphic objects such as lines, arcs, rectangles, ovals, regions, and bitmap images. Carbon supports most of the classic QuickDraw programming interface.

Functions

  • QDPictCreateWithProvider QDPictCreateWithProvider Available in OS X v10.1 through OS X v10.6

    Creates a QDPict picture, using QuickDraw picture data supplied with a Quartz data provider.

    Declaration

    Objective-C

    QDPictRef QDPictCreateWithProvider ( CGDataProviderRef provider );

    Parameters

    provider

    A Quartz data provider that supplies QuickDraw picture data. The picture data must begin at either the first byte or the 513th byte in the data provider. The picture bounds must not be an empty rectangle.

    QuickDraw retains the data provider you pass in, and you may safely release it after this function returns.

    Return Value

    A new QDPict picture, or NULL if the picture data is not valid. The initial retain count is 1. After you finish using the picture, you should release it by calling QDPictRelease.

    Discussion

    This function creates a QDPict picture that you can draw in a Quartz context. For general information about QDPict pictures, see QDPictRef.

    Availability

    Available in OS X v10.1 through OS X v10.6.

    Not available to 64-bit applications.

  • QDPictCreateWithURL QDPictCreateWithURL Available in OS X v10.1 through OS X v10.6

    Creates a QDPict picture, using QuickDraw picture data specified with a Core Foundation URL.

    Declaration

    Objective-C

    QDPictRef QDPictCreateWithURL ( CFURLRef url );

    Parameters

    url

    A Core Foundation URL that specifies a PICT file containing the QuickDraw picture data. The picture header data must begin at either the first byte or the 513th byte in the PICT file. The picture bounds must not be an empty rectangle.

    Return Value

    A new QDPict picture, or NULL if the picture data is not valid. The initial retain count is 1. After you finish using the picture, you should release it by calling QDPictRelease.

    Discussion

    This function creates a QDPict picture that you can draw in a Quartz context. For general information about QDPict pictures, see QDPictRef.

    Availability

    Available in OS X v10.1 through OS X v10.6.

    Not available to 64-bit applications.

  • QDPictDrawToCGContext QDPictDrawToCGContext Available in OS X v10.1 through OS X v10.6

    Draws a QuickDraw picture in a Quartz context.

    Declaration

    Objective-C

    OSStatus QDPictDrawToCGContext ( CGContextRef ctx, CGRect rect, QDPictRef pictRef );

    Parameters

    context

    The Quartz context in which to draw.

    rect

    The rectangular area in which to draw the picture. You should specify the origin and size of this rectangle in user space units. The origin is the lower left corner of the picture when drawn. If necessary, the picture is scaled to fit inside this rectangle. To get unscaled results, you should pass the rectangle returned by QDPictGetBounds. For additional information about scaling, see the discussion below.

    picture

    A QDPict picture.

    Return Value

    A result code. A non-zero result indicates that the picture was not successfully drawn.

    Discussion

    This function converts the picture data in a QDPict picture into an equivalent sequence of Quartz 2D graphics operations. Conceptually this is the same processing path taken when an application running in Mac OS X draws into a QuickDraw printing port.

    When drawing a QDPict picture in a Quartz context, there are two ways to change the horizontal or vertical scale of the picture:

    • Construct the drawing rectangle (see the rect parameter) by applying the change of scale to the bounds rectangle returned by QDPictGetBounds. In this case, QuickDraw scales all the graphic elements in the picture except for patterns—the same behavior as DrawPicture.

    • Prior to calling QDPictDrawToCGContext, apply the change of scale to the current transformation matrix in the Quartz context—for example, by calling CGContextScaleCTM. In this case, QuickDraw scales the entire picture including patterns.

    In a bitmap-based context, the picture is rendered into the bitmap. In a PDF-based context, the picture is converted into a PDF content stream. If the picture uses transfer modes such as srcXor that do not have an analog in Quartz 2D, the PDF representation may not match the original exactly.

    Availability

    Available in OS X v10.1 through OS X v10.6.

    Not available to 64-bit applications.

  • QDPictGetBounds QDPictGetBounds Available in OS X v10.1 through OS X v10.6

    Returns the intended location and size of a QDPict picture.

    Declaration

    Objective-C

    CGRect QDPictGetBounds ( QDPictRef pictRef );

    Parameters

    picture

    A QDPict picture.

    Return Value

    A Quartz rectangle that represents the intended location and size of the picture. The rectangle is in default user space with one unit = 1/72 inch, and the origin is the lower-left corner of the picture.

    Discussion

    If the native resolution in the picture data is not 72 pixels per inch, the bounding rectangle returned by this function is scaled as follows:

    • width = width in pixels * 72 / horizontal resolution
    • height = height in pixels * 72 / vertical resolution

    Availability

    Available in OS X v10.1 through OS X v10.6.

    Not available to 64-bit applications.

  • QDPictGetResolution QDPictGetResolution Available in OS X v10.1 through OS X v10.6

    Returns the horizontal and vertical resolution of a QDPict picture.

    Declaration

    Objective-C

    void QDPictGetResolution ( QDPictRef pictRef, float *xRes, float *yRes );

    Parameters

    picture

    A QDPict picture.

    xRes

    A pointer to your storage for a return value. Upon completion, the value is the picture’s horizontal resolution in pixels per inch.

    yRes

    A pointer to your storage for a return value. Upon completion, the value is the picture’s vertical resolution in pixels per inch.

    Discussion

    This function returns resolution data that you can use—together with the rectangle returned by QDPictGetBounds—to compute the picture’s size in pixels.

    Availability

    Available in OS X v10.1 through OS X v10.6.

    Not available to 64-bit applications.

  • QDPictRetain QDPictRetain Available in OS X v10.1 through OS X v10.6

    Retains a QDPict picture.

    Declaration

    Objective-C

    QDPictRef QDPictRetain ( QDPictRef pictRef );

    Parameters

    picture

    A QDPict picture.

    Return Value

    The retained picture.

    Discussion

    You should call this function when you obtain a QDPict picture that you did not create and you want to retain the picture for later use. When you no longer need the retained picture, you should call QDPictRelease to release it.

    Availability

    Available in OS X v10.1 through OS X v10.6.

    Not available to 64-bit applications.

  • QDPictRelease QDPictRelease Available in OS X v10.1 through OS X v10.6

    Releases a QDPict picture.

    Declaration

    Objective-C

    void QDPictRelease ( QDPictRef pictRef );

    Parameters

    picture

    A QDPict picture which you created or retained.

    Discussion

    After you finish using a QDPict picture that you created or retained, you should call this function to release the picture. If the picture’s retain count becomes 0, this function frees the picture and any associated resources such as the picture’s data provider.

    Availability

    Available in OS X v10.1 through OS X v10.6.

    Not available to 64-bit applications.

  • Returns a Quartz 2D drawing environment associated with a graphics port.

    Declaration

    Objective-C

    OSStatus QDBeginCGContext ( CGrafPtr inPort, CGContextRef *outContext );

    Parameters

    port

    A color graphics port in which to draw. Offscreen graphics worlds with pixel depths of 1, 2, 4, and 8 are not supported. When using Quartz 2D to draw in a offscreen graphics world, alpha information is always ignored.

    contextPtr

    A pointer to your storage for a Quartz context. Upon completion, contextPtr points to a context associated with the port. The context matches the port’s pixel depth, width, and height. Otherwise the context is in a default state and does not necessarily match other port attributes such as foreground color, background color, or clip region.

    You should not retain or release the context. When you are finished using the context, you should call QDEndCGContext.

    Return Value

    A result code. If noErr, the context was successfully initiated.

    Discussion

    Applications running in Mac OS X can use Quartz 2D to draw in a QuickDraw graphics port. When you call this function, you obtain a Quartz context that’s associated with the specified port. To improve performance, contexts returned by this function are cached and reused during subsequent calls whenever possible.

    Each block of Quartz 2D drawing code in your application should be surrounded by calls to this function and QDEndCGContext. Nested calls to this function for the same graphics port are not permitted—that is, for a given port you should not call this function more than once without an intervening call to QDEndCGContext.

    While the Quartz context is in use, all Quickdraw imaging operations in the associated graphics port are disabled. This is done because the operations would fail during printing.

    For information about how to use a Quartz context, see Quartz 2D Programming Guide.

    Availability

    Available in OS X v10.1 and later.

    Not available to 64-bit applications.

  • Terminates a Quartz 2D drawing environment associated with a graphics port.

    Declaration

    Objective-C

    OSStatus QDEndCGContext ( CGrafPtr inPort, CGContextRef *inoutContext );

    Parameters

    port

    A graphics port specified in a preceding call to QDBeginCGContext.

    contextPtr

    A pointer to the context obtained in the preceding call to QDBeginCGContext for the port. Upon completion, the storage pointed to by contextPtr is set to NULL.

    Return Value

    A result code. If noErr, the context is terminated.

    Discussion

    After you finish using Quartz 2D to draw in a graphics port, you should call this function to terminate the context. For more information, see QDBeginCGContext.

    Before calling this function, you should do one of the following:

    • Call CGContextSynchronize to mark the affected areas of the port for update.

    • Call CGContextFlush to immediately update the destination device.

    Availability

    Available in OS X v10.1 and later.

    Not available to 64-bit applications.

  • ClipCGContextToRegion ClipCGContextToRegion Available in OS X v10.0 through OS X v10.6

    Sets the clipping path in a Quartz 2D graphics context, using a clipping region.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    OSStatus ClipCGContextToRegion ( CGContextRef gc, const Rect *portRect, RgnHandle region );

    Parameters

    context

    A Quartz context associated with a graphics port. You can obtain such a context by calling QDBeginCGContext.

    portRect

    The portRect for the graphics port associated with the context.

    region

    A region that represents the desired clipping path.

    Return Value

    A result code. If noErr, the clipping path is now the region-based path.

    Discussion

    This function sets the clipping path in the specified context to closely approximate the geometry of the specified region.

    Unlike clipping in Quartz 2D, this function does not intersect the new region-based path with the current clipping path—the new path simply replaces the current clipping path.

    You should use this function only when absolutely necessary—it’s relatively inefficient when compared to Quartz 2D clipping functions such as CGContextClipToRect.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SyncCGContextOriginWithPort SyncCGContextOriginWithPort Available in OS X v10.0 through OS X v10.6

    Synchronizes the origin in a Quartz context with the lower-left corner of the associated graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    OSStatus SyncCGContextOriginWithPort ( CGContextRef inContext, CGrafPtr port );

    Parameters

    context

    A Quartz context associated with a graphics port. You can obtain such a context by calling QDBeginCGContext.

    port

    The graphics port associated with the context.

    Return Value

    A result code. If noErr, the context’s origin was successfully changed.

    Discussion

    If you’re using Quartz 2D to draw in a graphics port and SetOrigin is called to change the port’s origin, you can call this function to maintain the correspondence between the context’s origin and the lower-left corner of the portBounds rectangle.

    When you call this function:

    1. The current transformation matrix (CTM) is reset to its default values. Any changes you made to the CTM prior to calling this function are lost.

    2. The CTM is translated to establish the new origin, taking the port’s current origin into account.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • CreateCGContextForPort CreateCGContextForPort Available in OS X v10.0 through OS X v10.6

    Creates a Quartz 2D drawing environment associated with a graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    OSStatus CreateCGContextForPort ( CGrafPtr inPort, CGContextRef *outContext );

    Parameters

    port

    A color graphics port in which to draw. Offscreen graphics worlds with pixel depths of 1, 2, 4, and 8 are not supported. When using Quartz 2D to draw in a offscreen graphics world, alpha information is always ignored. Printing ports are not supported—if you specify a printing port, this function does nothing and returns a non-zero result code.

    contextPtr

    A pointer to your storage for a Quartz context. Upon completion, contextPtr points to a context associated with the port. The context matches the port’s pixel depth, width, and height. Otherwise the context is in a default state and does not necessarily match other port attributes such as foreground color, background color, or clip region.

    You should release this context when you no longer need it.

    Return Value

    A result code. If noErr, the context was successfully created.

    Discussion

    This function is not recommended in Mac OS X version 10.1 and later. For information about its replacement, see QDBeginCGContext.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • LockPortBits LockPortBits Available in OS X v10.0 through OS X v10.6

    Acquires an exclusive lock on the back buffer for a Carbon window.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    OSErr LockPortBits ( GrafPtr port );

    Parameters

    port

    A window port.

    Return Value

    A result code. If noErr, the window’s back buffer is locked and available for direct access.

    Discussion

    In Mac OS X, a Carbon window’s port bits are in a back buffer shared by the application and the Quartz compositor (sometimes called the window server). When an application needs to update this buffer, the Quartz compositor must be locked out temporarily. You can use this function together with UnlockPortBits to acquire and release an exclusive lock.

    If you’re using QuickDraw or Quartz 2D to draw in a window, you do not need to call this function—buffer locks are handled for you automatically. If you’re writing code that reads or modifies the port bits directly, you should bracket your code with calls to this function and UnlockPortBits.

    Nested calls to this function for the same port are permitted. For a given port, if you call LockPortBits n times, the lock is actually released after the nth balancing call to UnlockPortBits.

    You should not call any QuickTime functions while holding the lock. To avoid degrading the user experience, you should release the lock as quickly as possible.

    In Mac OS 9, this function does nothing and returns noErr.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • UnlockPortBits UnlockPortBits Available in OS X v10.0 through OS X v10.6

    Releases a previously acquired lock on the back buffer for a Carbon window.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    OSErr UnlockPortBits ( GrafPtr port );

    Parameters

    port

    A window port specified in a previous call to LockPortBits.

    Return Value

    A result code. If noErr, the corresponding lock is released.

    Discussion

    For more information about this function, see LockPortBits.

    In Mac OS 9, this function does nothing and returns noErr.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • QDFlushPortBuffer QDFlushPortBuffer Available in OS X v10.0 through OS X v10.6

    Calls the Quartz compositor to flush all new drawing in a Carbon window to the display.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void QDFlushPortBuffer ( CGrafPtr port, RgnHandle region );

    Parameters

    port

    A window port. If the port has no back buffer, or if the port is an offscreen or printing port, this function does nothing.

    region

    An update region. Under normal conditions, you should pass NULL to avoid the overhead of additional region operations.

    Discussion

    In Mac OS X, drawing in a window port updates a back buffer associated with the window. Updates to this buffer are accumulated in a list called the dirty region.

    The back buffer is automatically flushed to the display each time through the event loop. When the event loop does not get control soon enough—for example, during an animation sequence—you can call this function to flush the port buffer to the device immediately.

    When you call this function, there are several different execution paths:

    1. If the region parameter is NULL, the dirty region is flushed—along with any Quartz 2D drawing operations marked for update by calls to CGContextSynchronize—and the dirty region is set to empty.

    2. If the region parameter specifies an update region, the intersection of the dirty region and the update region is flushed—along with any Quartz 2D drawing operations marked for update by calls to CGContextSynchronize—and the flushed region is subtracted from the dirty region.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • QDGetCGDirectDisplayID QDGetCGDirectDisplayID Available in OS X v10.3 through OS X v10.6

    Returns the Quartz display ID that corresponds to a QuickDraw graphics device.

    Declaration

    Objective-C

    CGDirectDisplayID QDGetCGDirectDisplayID ( GDHandle inGDevice );

    Parameters

    inGDevice

    A QuickDraw graphics device.

    Return Value

    A Quartz display ID, or NULL if the inGDevice parameter does not represent a display. For information about using a display ID, see Quartz Display Services Reference.

    Availability

    Available in OS X v10.3 through OS X v10.6.

    Not available to 64-bit applications.

  • CreateNewPortForCGDisplayID CreateNewPortForCGDisplayID Available in OS X v10.0 through OS X v10.6

    Creates a graphics port associated with a display.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    CGrafPtr CreateNewPortForCGDisplayID ( UInt32 inCGDisplayID );

    Parameters

    displayID

    A display identifier. If the identifier is not valid, the main display is used instead. For information about finding displays, see Quartz Display Services Reference.

    Return Value

    A new display port. The portBounds rectangle is the same size as the display. When you are finished using the port, you should call DisposePort to release it.

    Discussion

    This function returns a graphics port used to draw directly to a display. The pixel map for the new port is taken from the GDevice record corresponding to the display. There is no back buffer associated with the port.

    Before calling this function, you should capture the display. For information about capturing displays, see Quartz Display Services Reference.

    You should not call this function and then attempt to create a Quartz drawing environment inside the port. Instead, applications using Quartz 2D can call CGDisplayGetDrawingContext to obtain a context suitable for drawing directly to a captured display.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • CalcMask CalcMask Available in OS X v10.0 through OS X v10.6

    Determines where filling will not occur when filling from the outside of a rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void CalcMask ( const void *srcPtr, void *dstPtr, short srcRow, short dstRow, short height, short words );

    Parameters

    srcPtr

    A pointer to the source bit image.

    dstPtr

    A pointer to the destination bit image.

    srcRow

    Row width of the source bitmap.

    dstRow

    Row width of the destination bitmap.

    height

    Height (in pixels) of the fill rectangle.

    words

    Width (in words) of the fill rectangle.

    Discussion

    The CalcMask function produces a bit image with 1’s in all pixels to which paint could not flow from any of the outer edges of the rectangle. Use this bit image as a mask with the CopyBits or CopyMask function. A hollow object produces a solid mask, but an open object produces a mask of itself.

    As with the SeedFill function, point to the bit image you want to fill with the srcPtr parameter, which can point to the image’s base address or a word boundary within the image. Specify a pixel height and word width with the height and words parameters to define a fill rectangle that delimits the area you want to fill. The fill rectangle can be the entire bit image or a subset of it. Point to a destination image with the dstPtr parameter. Specify the row widths of the source and destination bitmaps (their rowBytes values) with the srcRow and dstRow parameters. (The bitmaps can be different sizes, but they must be large enough to contain the fill rectangle at the origins specified by srcPtr and dstPtr.)

    Calls to CalcMask are not clipped to the current port and are not stored into QuickDraw pictures.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SeedFill SeedFill Available in OS X v10.0 through OS X v10.6

    Determines how far filling will extend from a seeding point.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SeedFill ( const void *srcPtr, void *dstPtr, short srcRow, short dstRow, short height, short words, short seedH, short seedV );

    Parameters

    srcPtr

    A pointer to the source bit image.

    dstPtr

    On input, a pointer to the destination bit image; upon return, a pointer to the bitmap containing the resulting mask.

    srcRow

    Row width of the source bitmap.

    dstRow

    Row width of the destination bitmap.

    height

    Height (in pixels) of the fill rectangle.

    words

    Width (in words) of the fill rectangle.

    seedH

    The horizontal offset (in pixels) at which to begin filling the destination bit image.

    seedV

    The vertical offset (in pixels) at which to begin filling the destination bit image.

    Discussion

    The SeedFill function produces a mask showing where bits in an image can be filled from a starting point, like the paint pouring from the MacPaint paint-bucket tool. The SeedFill returns this mask in the dstPtr parameter. This mask is a bitmap filled with 1’s only where the pixels in the source image can be filled. You can then use this mask with the CopyBits, CopyMask, and CopyDeepMask functions.

    Point to the bit image you want to fill with the srcPtr parameter, which can point to the image’s base address or a word boundary within the image. Specify a pixel height and word width with the height and words parameters to define a fill rectangle that delimits the area you want to fill. The fill rectangle can be the entire bit image or a subset of it. Point to a destination image with the dstPtr parameter. Specify the row widths of the source and destination bitmaps (their rowBytes values) with the srcRow and dstRow parameters. (The bitmaps can be different sizes, but they must be large enough to contain the fill rectangle at the origins specified by the srcPtr and dstPtr parameters.)

    You specify where to begin filling with the seedH and seedV parameters: they specify a horizontal and vertical offset in pixels from the origin of the image pointed to by the srcPtr parameter. The SeedFill function calculates contiguous pixels from that point out to the boundaries of the fill rectangle, and it stores the result in the bit image pointed to by the dstPtr parameter.

    Calls to SeedFill are not clipped to the current port and are not stored into QuickDraw pictures.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • CalcCMask CalcCMask Available in OS X v10.0 through OS X v10.6

    Determines where filling will not occur when filling from the outside of a rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void CalcCMask ( const BitMap *srcBits, const BitMap *dstBits, const Rect *srcRect, const Rect *dstRect, const RGBColor *seedRGB, ColorSearchUPP matchProc, long matchData );

    Parameters

    srcBits

    The source image. If the image is in a pixel map, you must coerce its PixMap structure to a BitMap structure.

    dstBits

    The destination image. The CalcCMask function returns the generated bitmap mask in this parameter. You can then use this mask with the CopyBits, CopyMask, and CopyDeepMask functions.

    srcRect

    The rectangle of the source image.

    dstRect

    The rectangle of the destination image.

    seedRGB

    An RGBColor structure specifying the color for pixels that should not be filled.

    matchProc

    An optional matching function.

    matchData

    Data for the optional matching function.

    Discussion

    Specify a source image in the srcBits parameter and in the srcRect parameter, specify a rectangle within that source image. Starting from the edges of this rectangle, CalcCMask calculates which pixels cannot be filled. By default, CalcCMask returns 1’s in the mask to indicate which pixels have the exact color that you specify in the seedRGB parameter and which pixels are enclosed by shapes whose outlines consist entirely of pixels with this color.

    For instance, if the source image in srcBits contains a dark blue rectangle on a red background, and your application sets seedRGB equal to dark blue, then CalcCMask returns a mask with 1’s in the positions corresponding to the edges and interior of the rectangle, and the 0’s outside of the rectangle.

    If you set the matchProc and matchData parameters to 0, CalcCMask uses the exact color specified in the RGBColor structure that you supply in the seedRGB parameter. You can customize CalcCMask by writing your own color search function and pointing to it in the matchProc parameter. As with SeedCFill, you can then use the matchData parameter in any manner useful for your application.

    The CalcCMask function does not scale so the source and destination rectangles must be the same size. Calls to CalcCMask are not clipped to the current port and are not stored into QuickDraw pictures.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SeedCFill SeedCFill Available in OS X v10.0 through OS X v10.6

    Determines how far filling will extend to pixels matching the color of a particular pixel.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SeedCFill ( const BitMap *srcBits, const BitMap *dstBits, const Rect *srcRect, const Rect *dstRect, short seedH, short seedV, ColorSearchUPP matchProc, long matchData );

    Parameters

    srcBits

    The source image. If the image is in a pixel map, you must coerce its PixMap structure to a BitMap structure.

    dstBits

    On return, the destination mask.

    srcRect

    The rectangle of the source image.

    dstRect

    The rectangle of the destination image.

    seedH

    The horizontal position of the seed point.

    seedV

    The vertical position of the seed point.

    matchProc

    An optional color search function.

    matchData

    Data for the optional color search function.

    Discussion

    The SeedCFill function generates a mask showing where the pixels in an image can be filled from a starting point, like the paint pouring from the MacPaint paint-bucket tool. This mask is a bitmap filled with 1’s to indicate all pixels adjacent to a seed point whose colors do not exactly match the RGBColor structure for the pixel at the seed point. You can then use this mask with the CopyBits, CopyMask, and CopyDeepMask functions.

    You specify a source image in the srcBits parameter and, in the srcRect parameter, specify a rectangle within that source image. You specify where to begin seeding in the seedH and seedV parameters, which must be the horizontal and vertical coordinates of a point in the local coordinate system of the source bitmap. By default, the 1’s returned in the mask indicate all pixels adjacent to the seed point whose pixel values do not exactly match the pixel value of the pixel at the seed point. To use this default, set the matchProc and matchData parameters to 0.

    In generating the mask, SeedCFill uses the CopyBits function to convert the source image to a 1-bit mask. The SeedCFill function installs a default color search function that returns 0 if the pixel value matches that of the seed point all other pixel values return 1’s.

    The SeedCFill function does not scale so the source and destination rectangles must be the same size. Calls to SeedCFill are not clipped to the current port and are not stored into QuickDraw pictures.

    To customize SeedCFill, write your own color search function and point to it in the matchProc parameter; SeedCFill will then use your function instead of the default.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetCursor GetCursor Available in OS X v10.0 through OS X v10.6

    Loads a cursor resource into memory.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    CursHandle GetCursor ( short cursorID );

    Parameters

    cursorID

    The resource ID for the cursor you want to display. You can supply one of the Cursor ID Constants to get a handle to one of the standard cursors.

    Return Value

    A handle to a Cursor structure for the cursor with the resource ID that you specify in the cursorID parameter. If the resource cannot be read into memory, GetCursor returns NULL.

    Discussion

    To get a handle to a color cursor, use the GetCCursor function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SetCursor SetCursor Available in OS X v10.0 through OS X v10.6

    Sets the current cursor.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SetCursor ( const Cursor *crsr );

    Parameters

    crsr

    A Cursor structure for the cursor to be displayed.

    Discussion

    If the cursor is hidden, it remains hidden and attains its new appearance only when it’s uncovered. If the cursor is already visible, it changes to the new appearance immediately.

    You need to use the InitCursor function to initialize the standard arrow cursor and make it visible on the screen before you call SetCursor to change the cursor’s appearance.

    To display a color cursor, use the SetCCursor function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • AllocCursor AllocCursor Available in OS X v10.0 through OS X v10.6

    Reallocates cursor memory.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void AllocCursor ( void );

    Discussion

    Under normal circumstances, you should never need to use this function, since Color QuickDraw handles reallocation of cursor memory.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • DisposeCCursor DisposeCCursor Available in OS X v10.0 through OS X v10.6

    Disposes of all structures allocated by the GetCCursor function.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DisposeCCursor ( CCrsrHandle cCrsr );

    Parameters

    cCrsr

    A handle to the color cursor to be disposed of.

    Discussion

    Use DisposeCCursor for each call to the GetCCursor function.

    The DisposeCCursor function is also available as the DisposCCursor function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetCCursor GetCCursor Available in OS X v10.0 through OS X v10.6

    Loads a color cursor resource into memory.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    CCrsrHandle GetCCursor ( short crsrID );

    Parameters

    crsrID

    The resource ID of the cursor that you want to display.

    Return Value

    A handle to the new CCrsr structure. To display this cursor on the screen, call SetCCursor. If a resource with the specified ID isn’t found, then this function returns a NULL handle.

    Discussion

    The GetCCursor function creates a new CCrsr structure and initializes it using the information in the ‘crsr’ resource with the specified ID.

    Since the GetCCursor function creates a new CCrsr structure each time it is called, do not call the GetCCursor function before each call to the SetCCursor function. Unlike the way GetCursor and SetCursor are normally used, GetCCursor does not dispose of or detach the resource, so resources of type 'crsr' should typically be purgeable. Call the DisposeCCursor function when you are finished using the color cursor created with GetCCursor.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SetCCursor SetCCursor Available in OS X v10.0 through OS X v10.6

    Specifies a color cursor for display on the screen.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SetCCursor ( CCrsrHandle cCrsr );

    Parameters

    cCrsr

    A handle to the color cursor to be displayed.

    Discussion

    At the time the cursor is set, it is expanded to the current screen depth so that it can be drawn rapidly. You must call GetCCursor before you call SetCCursor; however, you can make several subsequent calls to SetCCursor once GetCCursor creates the CCrsr structure.

    If your application has changed the cursor’s data or its color table, it must also invalidate the crsrXValid and crsrID fields of the CCrsr structure before calling SetCCursor.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • BackPat BackPat Available in OS X v10.0 through OS X v10.6

    Changes the bit pattern used as the background pattern by the current graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void BackPat ( const Pattern *pat );

    Parameters

    pat

    A bit pattern, as defined by a Pattern structure.

    Discussion

    The BackPat function sets the bit pattern defined in the Pattern structure, which you specify in the pat parameter, to be the background pattern. (The standard bit patterns white, black, gray, ltGray, and dkGray are predefined; the initial background pattern for the graphics port is white.) This pattern is stored in the bkPat field of a GrafPort structure.

    The BackPat function also sets a bit pattern for the background color in a color graphics port. The BackPat function creates a handle, of type PixPatHandle, for the bit pattern and stores this handle in the bkPixPat field of the CGrafPort structure. As in basic graphics ports, Color QuickDraw draws patterns in color graphics ports at the time of drawing, not at the time you use PenPat to set the pattern.

    To define your own patterns, you typically create pattern, ‘PAT’, or pattern list, ‘PAT#’, resources.

    Special Considerations

    The BackPat function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • BackPixPat BackPixPat Available in OS X v10.0 through OS X v10.6

    Assigns a pixel pattern as the background pattern.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void BackPixPat ( PixPatHandle pp );

    Parameters

    pp

    A handle to the pixel pattern to use as the background pattern.

    Discussion

    Setting the background pattern allows the ScrollRect function and the shape-erasing functions (for example, EraseRect) to fill the background with a colored patterned “ink.”

    The BackPixPat function is similar to the basic QuickDraw function BackPat, except that you pass BackPixPat a handle to a multicolored pixel pattern instead of a bit pattern.

    The handle to the pixel pattern is stored in the bkPixPat field of the CGrafPort structure, therefore, you should not dispose of this handle since QuickDraw removes all references to your pattern from an existing graphics port when you dispose of it.

    If you use BackPixPat to set a background pixel pattern in a basic graphics port, the data in the pat1Data field of the PixPat structure is placed into the bkPat field of the GrafPort structure.

    To define your own pixel pattern, create a pixel pattern resource, x is described on 'ppat', or use the NewPixPat function. To set the background pattern to a bit pattern, you can also use the QuickDraw function, BackPat.

    Special Considerations

    The BackPixPat function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PackBits PackBits Available in OS X v10.0 through OS X v10.6

    Compresses a data buffer stored in RAM.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void PackBits ( Ptr *srcPtr, Ptr *dstPtr, short srcBytes );

    Parameters

    srcPtr

    On entry, a pointer to the first byte of a buffer of data to be compressed. On exit, a pointer to the first byte following the bytes compressed.

    dstPtr

    On entry, a pointer to the first byte in which to store compressed data. On exit, a pointer to the first byte following the compressed data.

    srcBytes

    The number of bytes of uncompressed data to be compressed. In versions of software prior to version 6.0.2, this number must be 127 or less.

    Discussion

    You must allocate memory for the destination buffer itself. Allocate enough memory for a worst-case scenario where the destination buffer is 128 bytes long for each block of source data up to 127 bytes. Use the following formula to determine how much space to allocate for the destination buffer:

    maxDstBytes := srcBytes + (srcBytes+126) DIV 127;

    where maxDstBytes stands for the maximum number of destination bytes.

    The PackBits algorithm is most effective on data buffers in which there are likely to be series of bytes containing the same value. For example, resources of many formats often contain many consecutive zeros. If you have a data buffer in which there are only likely to be a series of words or long words containing the same values, PackBits is unlikely to be effective.

    Special Considerations

    Because your application must allocate memory for the source and destination buffers, PackBits does not move relocatable blocks. Thus, you can call it at interrupt time.

    Because PackBits changes the values of the srcPtr and dstPtr parameters, you should pass to PackBits only copies of the pointers to the source and destination buffers. This allows you to access the beginning of the source and destination buffers after PackBits returns. Also, if the source or destination buffer is stored in an unlocked, relocatable block, this technique prevents PackBits from changing the value of a master pointer, which would make the original handle invalid.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • UnpackBits UnpackBits Available in OS X v10.0 through OS X v10.6

    Decompresses a data buffer containing data compressed by PackBits.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void UnpackBits ( Ptr *srcPtr, Ptr *dstPtr, short dstBytes );

    Parameters

    srcPtr

    On entry, a pointer to the first byte of a buffer of data to be decompressed. On exit, a pointer to the first byte following the compressed data.

    dstPtr

    On entry, a pointer to the first byte in which to store decompressed data. On exit, a pointer to the first byte following the decompressed data.

    dstBytes

    The number of bytes of the data before compression. Use PackBits to compress data structures of a fixed size that you can then pass in this parameter to UnpackBits, or store with the compressed data the original size of the uncompressed data.

    Discussion

    Because your application must allocate memory for the source and destination buffers, UnpackBits does not move relocatable blocks. Thus, you can call it at interrupt time.

    Because UnpackBits changes the values of the srcPtr and dstPtr parameters, you should pass to UnpackBits only copies of the pointers to the source and destination buffers. This allows you to access the beginning of the source and destination buffers after UnpackBits returns. Also, if the source or destination buffer is stored in an unlocked, relocatable block, this technique prevents UnpackBits from changing the value of a master pointer, which would make the original handle invalid.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • AngleFromSlope AngleFromSlope Available in OS X v10.0 through OS X v10.6

    Converts a slope value to an angle value.

    Declaration

    Objective-C

    short AngleFromSlope ( Fixed slope );

    Parameters

    slope

    The slope, defined as Dx/Dy, which is the horizontal change divided by the vertical change between any two points on a line with the slope.

    Return Value

    The angle corresponding to the slope specified in the slope parameter treated MOD 180. Angles are defined in clockwise degrees from 12 o’clock. The negative y-axis is defined as being at 12 o’clock, and the positive y-axis at 6 o’clock. The x-axis is defined as usual, with the positive side defined as being at 3 o’clock.

    Special Considerations

    The AngleFromSlope function is most useful when you require speed more than accuracy in performing the calculation. The integer result is within 1 degree of the correct answer, but not necessarily within half a degree.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • SlopeFromAngle SlopeFromAngle Available in OS X v10.0 through OS X v10.6

    Converts an angle value to a slope value.

    Declaration

    Objective-C

    Fixed SlopeFromAngle ( short angle );

    Parameters

    angle

    The angle, expressed in clockwise degrees from 12 o’clock and treated MOD 180. (90 degrees is thus at 3 o’clock and –90 degrees is at 9 o’clock.

    Return Value

    The slope corresponding to the angle specified in the angle parameter. Slopes are defined as Dx/Dy, the horizontal change divided by the vertical change between any two points on a line with the given angle. The negative y-axis is defined as being at 12 o’clock, and the positive y-axis at 6 o’clock. The x-axis is defined as usual, with the positive side defined as being at 3 o’clock.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • CopyBits CopyBits Available in OS X v10.0 through OS X v10.6

    Copies a portion of a bitmap or a pixel map from one graphics port or offscreen graphics world into another graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void CopyBits ( const BitMap *srcBits, const BitMap *dstBits, const Rect *srcRect, const Rect *dstRect, short mode, RgnHandle maskRgn );

    Parameters

    srcBits

    The source BitMap structure.

    dstBits

    The destination BitMap structure.

    srcRect

    The source rectangle.

    dstRect

    The destination rectangle.

    mode

    One of the eight source modes in which the copy is to be performed. See Source, Pattern, and Arithmetic Transfer Mode Constants. The CopyBits function always dithers images when shrinking them between pixel maps on direct devices.

    When transferring pixels from a source pixel map to a destination pixel map, color QuickDraw interprets the source mode constants differently than basic QuickDraw does.

    When you use CopyBits on a computer running color QuickDraw, you can also specify one of the transfer modes in the mode parameter.

    maskRgn

    A region to use as a clipping mask. You can pass a region handle to specify a mask region the resulting image is always clipped to this mask region and to the boundary rectangle of the destination bitmap. If the destination bitmap is the current graphics port’s bitmap, it is also clipped to the intersection of the graphics port’s clipping region and visible region. If you do not want to clip to a masking region, just pass NULL for this parameter.

    Discussion

    The CopyBits function transfers any portion of a bitmap between two basic graphics ports, or any portion of a pixel map between two color graphics ports. Use CopyBits to move offscreen graphic images into an onscreen window, to blend colors for the image in a pixel map, and to shrink and expand images.

    Specify a source bitmap in the srcBits parameter and a destination bitmap in the dstBits parameter. When copying images between color graphics ports, you must coerce each CGrafPort structure to a GrafPort structure, dereference the portBits fields of each, and then pass these “bitmaps” in the srcBits and dstBits parameters. If your application copies a pixel image from a color graphics port called MyColorPort, for example, you could specify (* GrafPtr(MyColorPort)).portBits in the srcBits parameter. In a CGrafPort structure, the high 2 bits of the portVersion field are set. This field, which shares the same position in a CGrafPort structure as the portBits.rowBytes field in a GrafPort structure, indicates to CopyBits that you have passed it a handle to a pixel map rather than a bitmap.

    Using the srcRect and dstRect parameters, you can specify identically or differently sized source and destination rectangles; for differently sized rectangles, CopyBits scales the source image to fit the destination. If the bit image is a circle in a square source rectangle, and the destination rectangle is not square, the bit image appears as an oval in the destination. When you specify rectangles in the srcRect and dstRect parameters, use the local coordinate systems of, respectively, the source and destination graphics ports.

    The CopyDeepMask function combines the functions of the CopyBits and CopyMask functions.

    Special Considerations

    When you use the CopyBits function to transfer an image between pixel maps, the source and destination images may be of different pixel depths, of different sizes, and they may have different color tables. However, CopyBits assumes that the destination pixel map uses the same color table as the color table for the current GDevice structure. (This is because the Color Manager requires an inverse table for translating the color table from the source pixel map to the destination pixel map.)

    The CopyBits function applies the foreground and background colors of the current graphics port to the image in the destination pixel map (or bitmap), even if the source image is a bitmap. This causes the foreground color to replace all black pixels in the destination and the background color to replace all white pixels. To avoid unwanted coloring of the image, use the RGBForeColor function to set the foreground to black and use the RGBBackColor function to set the background to white before calling CopyBits.

    The source bitmap or pixel map must not occupy more memory than half the available stack space. The stack space required by CopyBits is roughly five times the value of the rowBytes field of the source pixel map: one rowBytes value for the pixel map (or bitmap), an additional rowBytes value for dithering, another rowBytes value when stretching or shrinking the source pixel map into the destination, another rowBytes value for any color map changing, and a fifth additional rowBytes value for any color aliasing. If there is insufficient memory to complete a CopyBits operation in Color QuickDraw, the QDError function returns the result code –143.

    If you use CopyBits to copy between two graphics ports that overlap, you must first use the LocalToGlobal function to convert to global coordinates, and then specify the global variable screenBits for both the srcBits and dstBits parameters.

    The CopyBits function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    If you are reading directly from a NuBus video card with a base address of Fs00000 and there is not a card in the slot (s–1) below it, CopyBits reads addresses less than the base address of the pixel map. This causes a bus error. To work around the problem, remap the baseAddr field of the pixel map in your video card to at least 20 bytes above the NuBus boundary; an address link of Fs000020 precludes the problem.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • CopyDeepMask CopyDeepMask Available in OS X v10.0 through OS X v10.6

    Uses a mask when copying bitmaps or pixel maps between graphics ports (or from an offscreen graphics world into a graphics port).

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void CopyDeepMask ( const BitMap *srcBits, const BitMap *maskBits, const BitMap *dstBits, const Rect *srcRect, const Rect *maskRect, const Rect *dstRect, short mode, RgnHandle maskRgn );

    Parameters

    srcBits

    The source BitMap structure.

    maskBits

    The masking BitMap structure.

    dstBits

    The destination BitMap structure. The result is clipped to the mask region that you specify in the maskRgn parameter, and to the boundary rectangle that you specify in the dstRect parameter.

    srcRect

    The source rectangle.

    maskRect

    The mask rectangle. This must be the same size as the rectangle passed in the srcRect parameter. The rectangle you pass here selects the portion of the bitmap or pixel map that you specify in the maskBits parameter to use as the mask.

    dstRect

    The destination rectangle.

    mode

    The source mode.

    maskRgn

    The mask clipping region. If you do not want to clip to the mask region, specify NULL.

    Discussion

    CopyDeepMask combines the effects of the CopyBits and CopyMask functions. You specify a mask to CopyDeepMask so that it transfers the source image to the destination image only where the bits of the mask are set to 1. Use CopyDeepMask to move offscreen graphic images into an onscreen window, to blend colors for the image in a pixel map, and to shrink and expand images.

    When copying images between color graphics ports, you must coerce each port’s CGrafPort structure to a GrafPort structure, dereference the portBits fields of each, and then pass these “bitmaps” in the srcBits and dstBits parameters. If your application copies a pixel image from a color graphics port called MyColorPort, for example, you could specify (* GrafPtr(MyColorPort)).portBits in the srcBits parameter. The transfer can be performed in any of the transfer modes—with or without adding the ditherCopy constant—that are available to CopyBits.

    Using the srcRect and dstRect parameters, you can specify identically or differently sized source and destination rectangles; for differently sized rectangles, CopyDeepMask scales the source image to fit the destination. When you specify rectangles in the srcRect and dstRect parameters, use the local coordinate systems of, respectively, the source and destination graphics ports.

    If you specify pixel maps to CopyDeepMask, they may range from 1 to 32 pixels in depth. The pixel depth of the mask that you specify in the maskBits parameter is applied as a filter between the source and destination pixel maps that you specify in the srcBits and dstBits parameters. A black mask pixel value means that the copy operation is to take the source pixel a white value means that the copy operation is to take the destination pixel. Intermediate values specify a weighted average, which is calculated on a color component basis. For each pixel’s color component value, the calculation is

    (1 – mask) x source + (mask) x destination

    Thus high mask values for a pixel’s color component reduce that component’s contribution from the source PixMap structure.

    Special Considerations

    As with the CopyMask function, calls to CopyDeepMask are not recorded in pictures and do not print.

    See the list of special considerations for CopyBits; these considerations also apply to CopyDeepMask.

    The CopyDeepMask function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • CopyMask CopyMask Available in OS X v10.0 through OS X v10.6

    Copies a bit or pixel image from one graphics port or offscreen graphics world into another graphics port only where the bits in a mask are set to 1.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void CopyMask ( const BitMap *srcBits, const BitMap *maskBits, const BitMap *dstBits, const Rect *srcRect, const Rect *maskRect, const Rect *dstRect );

    Parameters

    srcBits

    The source BitMap structure.

    maskBits

    The mask BitMap structure.

    dstBits

    The destination BitMap structure.

    srcRect

    The source rectangle.

    maskRect

    The mask rectangle. This must be the same size as the rectangle passed in the srcRect parameter. The rectangle you pass in this parameter selects the portion of the bitmap or pixel map that you specify in the maskBits parameter to use as the mask.

    dstRect

    The destination rectangle.

    Discussion

    The CopyMask function copies the source bitmap or pixel map that you specify in the srcBits parameter to a destination bitmap or pixel map that you specify in the dstBits parameter—but only where the bits of the mask bitmap or pixel map that you specify in the maskBits parameter are set to 1. When copying images between color graphics ports, you must coerce each CGrafPort structure to a GrafPort structure, dereference the portBits fields of each, and then pass these “bitmaps” in the srcBits and dstBits parameters. If your application copies a pixel image from a color graphics port called MyColorPort, for example, you could specify (* GrafPtr(MyColorPort)).portBits in the srcBits parameter.

    Using the srcRect and dstRect parameters, you can specify identically or differently sized source and destination rectangles; for differently sized rectangles, CopyMask scales the source image to fit the destination. When you specify rectangles in the srcRect and dstRect parameters, use the local coordinate systems of, respectively, the source and destination graphics ports.

    If you specify pixel maps to CopyMask, they may range from 1 to 32 pixels in depth. The pixel depth of the mask that you specify in the maskBits parameter is applied as a filter between the source and destination pixel maps that you specify in the srcBits and dstBits parameters. A black mask pixel value means that the copy operation is to take the source pixel a white value means that the copy operation is to take the destination pixel. Intermediate values specify a weighted average, which is calculated on a color component basis. For each pixel’s color component value, the calculation is

    (1 – mask) x source + (mask) x destination

    Thus high mask values for a pixel’s color component reduce that component’s contribution from the source PixMap structure.

    Use the bitmap returned by CalcMask as the mask in order to implement a mask copy similar to that performed by the MacPaint lasso tool. In the same way, you can use the pixel map returned by the CalcCMask function.

    The CopyDeepMask function combines the functions of the CopyMask and CopyBits functions.

    Special Considerations

    Calls to CopyMask are not recorded in pictures and do not print.

    See the list of special considerations for CopyBits; these considerations also apply to CopyMask.

    The CopyMask function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • DisposeGWorld DisposeGWorld Available in OS X v10.0 through OS X v10.6

    Disposes of all the memory allocated for an offscreen graphics world.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DisposeGWorld ( GWorldPtr offscreenGWorld );

    Parameters

    offscreenGWorld

    A pointer to an offscreen graphics world. In this parameter, pass the pointer returned to your application by the NewGWorld function when you created the offscreen graphics world.

    Discussion

    The DisposeGWorld function disposes of all the memory allocated for the specified offscreen graphics world, including the pixel map, color table, pixel image, and GDevice structure (if one was created).

    Call DisposeGWorld only when your application no longer needs the pixel image associated with this offscreen graphics world. If this offscreen graphics world was the current device, the current device is reset to the device stored in the global variable MainDevice.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • DisposeScreenBuffer DisposeScreenBuffer Available in OS X v10.0 through OS X v10.6

    Disposes an offscreen graphics world.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DisposeScreenBuffer ( PixMapHandle offscreenPixMap );

    Parameters

    offscreenPixMap

    A handle to an existing offscreen PixMap structure.

    Discussion

    Generally, applications do not need to use DisposeScreenBuffer. The DisposeGWorld function uses the DisposeScreenBuffer function when disposing of an offscreen graphics world.

    The DisposeScreenBuffer function disposes of the memory allocated for the base address of an offscreen pixel image.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • NewGWorld NewGWorld Available in OS X v10.0 through OS X v10.6

    Creates an offscreen graphics world.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    QDErr NewGWorld ( GWorldPtr *offscreenGWorld, short PixelDepth, const Rect *boundsRect, CTabHandle cTable, GDHandle aGDevice, GWorldFlags flags );

    Parameters

    offscreenGWorld

    On return, a pointer to the offscreen graphics world created by this function. You use this pointer when referring to this new offscreen world in other QuickDraw functions.

    PixelDepth

    The pixel depth of the offscreen world; possible depths are 1, 2, 4, 8, 16, and 32 bits per pixel. The default parameter (0) uses the pixel depth of the screen with the greatest pixel depth from among all screens whose boundary rectangles intersect the rectangle that you specify in the boundsRect parameter. If you specify 0 in this parameter, NewGWorld also uses the GDevice structure from this device instead of creating a new GDevice structure for the offscreen world. If you use NewGWorld on a computer that supports only basic QuickDraw, you may specify only 0 or 1 in this parameter.

    boundsRect

    The boundary rectangle and port rectangle for the offscreen pixel map. This becomes the boundary rectangle for the GDevice structure, if NewGWorld creates one. If you specify 0 in the pixelDepth parameter, NewGWorld interprets the boundaries in global coordinates that it uses to determine which screens intersect the rectangle. NewGWorld then uses the pixel depth, color table, and GDevice structure from the screen with the greatest pixel depth from among all screens whose boundary rectangles intersect this rectangle. Typically, your application supplies this parameter with the port rectangle for the onscreen window into which your application will copy the pixel image from this offscreen world.

    cTable

    A handle to a ColorTable structure. If you pass NULL in this parameter, NewGWorld uses the default color table for the pixel depth that you specify in the pixelDepth parameter. If you set the pixelDepth parameter to 0, NewGWorld ignores the cTable parameter and instead copies and uses the color table of the graphics device with the greatest pixel depth among all graphics devices whose boundary rectangles intersect the rectangle that you specify in the boundsRect parameter. If you use NewGWorld on a computer that supports only basic QuickDraw, you may specify only NULL in this parameter.

    aGDevice

    A handle to a GDevice structure that is used only when you specify the noNewDevice flag in the flags parameter, in which case NewGWorld attaches this GDevice structure to the new offscreen graphics world. If you set the pixelDepth parameter to 0, or if you do not set the noNewDevice flag, NewGWorld ignores the aGDevice parameter, so set it to NULL. If you set the pixelDepth parameter to 0, NewGWorld uses the GDevice structure for the graphics device with the greatest pixel depth among all graphics devices whose boundary rectangles intersect the rectangle that you specify in the boundsRect parameter. You should pass NULL in this parameter if the computer supports only basic QuickDraw. Generally, your application should never create GDevice structures for offscreen graphics worlds.

    flags

    Options available to your application. You can set a combination of the flags pixPurge, noNewDevice, useTempMem, and keepLocal. If you don’t wish to use any of these flags, specify 0 in this parameter to accept the default behavior for NewGWorld. The default behavior creates an offscreen graphics world where the base address for the offscreen pixel image is unpurgeable, it uses an existing GDevice structure (if you pass 0 in the depth parameter) or creates a new GDevice structure, it uses memory in your application heap, and it allows graphics accelerators to cache the offscreen pixel image. See Graphics World Flags for a description of the values you can use here.

    Return Value

    A result code.

    Discussion

    Typically, you pass 0 in the pixelDepth parameter, a window’s port rectangle in the boundsRect parameter, NULL in the cTable and aGDevice parameters, and in the flags parameter a 0. This provides your application with the default behavior of NewGWorld, and it supports computers running basic QuickDraw. This also allows QuickDraw to optimize the CopyBits, CopyMask, and CopyDeepMask functions when your application copies the image in an offscreen graphics world into an onscreen graphics port.

    The NewGWorld function allocates memory for an offscreen graphics port and its pixel map. On computers that support only basic QuickDraw, NewGWorld creates a 1-bit pixel map that your application can manipulate using other relevant functions described in this chapter. Your application can copy this 1-bit pixel map into basic graphics ports.

    Unless you specify 0 in the pixelDepth parameter–or pass the noNewDevice flag in the flags parameter and supply a GDevice structure in the aGDevice parameter– NewGWorld also allocates a new offscreen GDevice structure.

    When creating an image, use the NewGWorld function to create an offscreen graphics world that is optimized for an image’s characteristics—for example, its best pixel depth. After creating the image, use the CopyBits, CopyMask, or CopyDeepMask function to copy that image to an onscreen graphics port. Color QuickDraw automatically renders the image at the best available pixel depth for the screen. Creating an image in an offscreen graphics port and then copying it to the screen in this way prevents the visual choppiness that would otherwise occur if your application were to build a complex image directly onscreen.

    The NewGWorld function initializes the offscreen graphics port by calling the OpenCPort function. The NewGWorld function sets the offscreen graphics port’s visible region to a rectangular region coincident with its boundary rectangle. The NewGWorld function generates an inverse table with the Color Manager function MakeITable, unless one of the GDevice structures for the screens has the same color table as the GDevice structure for the offscreen world, in which case NewGWorld uses the inverse table from that GDevice structure.

    The address of the offscreen pixel image is not directly accessible from the PixMap structure for the offscreen graphics world. However, you can use the GetPixBaseAddr function to get a pointer to the beginning of the offscreen pixel image.

    For purposes of estimating memory use, you can compute the size of the offscreen pixel image by using this formula:

    rowBytes * (boundsRect.bottom – boundsRect.top)

    In the flags parameter, you can specify several options. If you don’t want to use any of these options, pass 0 in the flags parameter:

    • If you specify the pixPurge flag, NewGWorld stores the offscreen pixel image in a purgeable block of memory. In this case, before drawing to or from the offscreen pixel image, your application should call the LockPixels function and ensure that it returns TRUE. If LockPixels returns FALSE, the memory for the pixel image has been purged, and your application should either call UpdateGWorld to reallocate it and then reconstruct the pixel image, or draw directly in a window instead of preparing the image in an offscreen graphics world. Never draw to or copy from an offscreen pixel image that has been purged without reallocating its memory and then reconstructing it.

    • If you specify the noNewDevice flag, NewGWorld does not create a new offscreen GDevice structure. Instead, it uses the GDevice structure that you specify in the aGDevice parameter–and its associated pixel depth and color table–to create the offscreen graphics world. (If you set the pixelDepth parameter to 0, NewGWorld uses the GDevice structure for the screen with the greatest pixel depth among all the screens whose boundary rectangles intersect the rectangle that you specify in the boundsRect parameter–even if you specify the noNewDevice flag.) The NewGWorld function keeps a reference to the GDevice structure for the offscreen graphics world, and the SetGWorld function uses that structure to set the current graphics device.

    • If you set the useTempMem flag, NewGWorld creates the base address for an offscreen pixel image in temporary memory. You generally would not use this flag, because you should use temporary memory only for fleeting purposes and only with the AllowPurgePixels function.

    • If you specify the keepLocal flag, your offscreen pixel image is kept in Macintosh main memory and is not cached to a graphics accelerator card. use this flag carefully, as it negates the advantages provided by any graphics acceleration card that might be present.

    If your application needs to change the pixel depth, boundary rectangle, or color table for an offscreen graphics world, use the UpdateGWorld function.

    Special Considerations

    If you supply a handle to a ColorTable structure in the cTable parameter, NewGWorld makes a copy of the structure and stores its handle in the offscreen PixMap structure. It is your application’s responsibility to make sure that the ColorTable structure you specify in the cTable parameter is valid for the offscreen graphics port’s pixel depth.

    If when using NewGWorld you specify a pixel depth, color table, or GDevice structure that differs from those used by the window into which you copy your offscreen image, the CopyBits, CopyMask, and CopyDeepMask functions require extra time to complete.

    To use a custom color table in an offscreen graphics world, you need to create the associated offscreen GDevice structure, because Color QuickDraw needs its inverse table.

    The NewGWorld function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • NewScreenBuffer NewScreenBuffer Available in OS X v10.0 through OS X v10.6

    Creates an offscreen PixMap structure and allocates memory for the base address of its pixel image.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    QDErr NewScreenBuffer ( const Rect *globalRect, Boolean purgeable, GDHandle *gdh, PixMapHandle *offscreenPixMap );

    Parameters

    globalRect

    The boundary rectangle, in global coordinates, for the offscreen pixel map.

    purgeable

    A value of TRUE to make the memory block for the offscreen pixel map purgeable, or a value of FALSE to make it unpurgeable.

    gdh

    On return, a pointer to the handle to the GDevice structure for the graphics device with the greatest pixel depth among all graphics devices whose boundary rectangles intersect the rectangle specified in the globalRect parameter.

    offscreenPixMap

    On return, a pointer to a handle to the new offscreen PixMap structure.

    Return Value

    A result code.

    Discussion

    Applications generally do not need to use NewScreenBuffer. The NewGWorld function uses the NewScreenBuffer function to create and allocate memory for an offscreen pixel image.

    Special Considerations

    The NewScreenBuffer function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • NewTempScreenBuffer NewTempScreenBuffer Available in OS X v10.0 through OS X v10.6

    Creates an offscreen PixMap structure and allocate temporary memory for the base address of its pixel image applications generally don’t need to use NewTempScreenBuffer.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    QDErr NewTempScreenBuffer ( const Rect *globalRect, Boolean purgeable, GDHandle *gdh, PixMapHandle *offscreenPixMap );

    Parameters

    globalRect

    The boundary rectangle, in global coordinates, for the offscreen pixel map.

    purgeable

    A value of TRUE to make the memory block for the offscreen pixel map purgeable, or a value of FALSE to make it unpurgeable.

    gdh

    On return, a pointer to the handle to the GDevice structure for the graphics device with the greatest pixel depth among all graphics devices whose boundary rectangles intersect the rectangle specified in the globalRect parameter.

    offscreenPixMap

    On return, a pointer to the handle to the new offscreen PixMap structure.

    Return Value

    A result code.

    Discussion

    The NewTempScreenBuffer function performs the same functions as NewScreenBuffer except that it creates the base address for the offscreen pixel image in temporary memory. When an application passes it the useTempMem flag, the NewGWorld function uses NewTempScreenBuffer instead of NewScreenBuffer.

    Your application should not need to use this function.

    Special Considerations

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

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • UpdateGWorld UpdateGWorld Available in OS X v10.0 through OS X v10.6

    Changes the pixel depth, boundary rectangle, or color table for an existing offscreen graphics world.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    GWorldFlags UpdateGWorld ( GWorldPtr *offscreenGWorld, short pixelDepth, const Rect *boundsRect, CTabHandle cTable, GDHandle aGDevice, GWorldFlags flags );

    Parameters

    offscreenGWorld

    On input, a pointer to an existing offscreen graphics world; upon completion, the pointer to the updated offscreen graphics world.

    pixelDepth

    The pixel depth of the offscreen world; possible depths are 1, 2, 4, 8, 16, and 32 bits per pixel. If you specify 0 in this parameter, UpdateGWorld rescans the device list and uses the depth of the screen with the greatest pixel depth among all screens whose boundary rectangles intersect the rectangle that you specify in the boundsRect parameter. If you specify 0 in this parameter, UpdateGWorld also copies the GDevice structure from this device to create an offscreen GDevice structure. The UpdateGWorld function ignores the value you supply for this parameter if you specify a GDevice structure in the aGDevice parameter.

    boundsRect

    The boundary rectangle and port rectangle for the offscreen pixel map. This also becomes the boundary rectangle for the GDevice structure, if NewGWorld creates one. If you specify 0 in the pixelDepth parameter, NewGWorld interprets the boundaries in global coordinates, with which it determines which screens intersect the rectangle. (NewGWorld then uses the pixel depth, color table, and GDevice structure from the screen with the greatest pixel depth from among all screens whose boundary rectangles intersect this rectangle.) Typically, your application supplies this parameter with the port rectangle for the onscreen window into which your application will copy the pixel image from this offscreen world.

    cTable

    A handle to a ColorTable structure. If you pass NULL in this parameter, UpdateGWorld uses the default color table for the pixel depth that you specify in the pixelDepth parameter; if you set the pixelDepth parameter to 0, UpdateGWorld copies and uses the color table of the graphics device with the greatest pixel depth among all graphics devices whose boundary rectangles intersect the rectangle that you specify in the boundsRect parameter. The UpdateGWorld function ignores the value you supply for this parameter if you specify a GDevice structure in the aGDevice parameter.

    aGDevice

    As an option, a handle to a GDevice structure whose pixel depth and color table you want to use for the offscreen graphics world. To use the pixel depth and color table that you specify in the pixelDepth and cTable parameters, set this parameter to NULL.

    flags

    Options available to your application. You can set a combination of the flags clipPix, stretchPix, and ditherPix. If you don’t wish to use any of these flags, specify 0. However, you should pass either clipPix or stretchPix to ensure that the pixel map is updated to reflect the new color table. See GWorldFlags for a description of the values you can use here.

    Return Value

    UpdateGWorld returns the gwFlagErr flag if UpdateGWorld was unsuccessful; in this case, the offscreen graphics world is left unchanged. Use the QDError function to help you determine why UpdateGWorld failed.

    Discussion

    You should call UpdateGWorld after every update event and whenever your windows move or change size.

    If the LockPixels function reports that the Memory Manager has purged the base address for the offscreen pixel image, use UpdateGWorld to reallocate its memory. Then, reconstruct the pixel image or draw directly in a window instead of preparing the image in an offscreen graphics world.

    The UpdateGWorld function uses the following algorithm when updating the offscreen pixel image:

    1. If the color table that you specify in the cTable parameter is different from the previous color table, or if the color table associated with the GDevice structure that you specify in the aGDevice parameter is different, Color QuickDraw maps the pixel values in the offscreen pixel map to the new color table.

    2. If the value you specify in the pixelDepth parameter differs from the previous pixel depth, Color QuickDraw translates the pixel values in the offscreen pixel image to those for the new pixel depth.

    3. If the rectangle you specify in the boundsRect parameter differs from, but has the same size as, the previous boundary rectangle, QuickDraw realigns the pixel image to the screen for optimum performance for the CopyBits function.

    4. If the rectangle you specify in the boundsRect parameter is smaller than the previous boundary rectangle and you specify the clipPix flag, the pixel image is clipped along the bottom and right edges.

    5. If the rectangle you specify in the boundsRect parameter is bigger than the previous boundary rectangle and you specify the clipPix flag, the bottom and right edges of the pixel image are undefined.

    6. If the rectangle you specify in the boundsRect parameter is smaller than the previous boundary rectangle and you specify the stretchPix flag, the pixel image is reduced to the new size.

    7. If the rectangle you specify in the boundsRect parameter is bigger than the previous boundary rectangle and you specify the stretchPix flag, the pixel image is stretched to the new size.

    8. If the Memory Manager purged the base address for the offscreen pixel image, UpdateGWorld reallocates the memory, but the pixel image is lost. You must reconstruct it.

    Special Considerations

    The UpdateGWorld function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • DisposeCTable DisposeCTable Available in OS X v10.0 through OS X v10.6

    Disposes a ColorTable structure.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DisposeCTable ( CTabHandle cTable );

    Parameters

    cTable

    A handle to a ColorTable structure to dispose of.

    Discussion

    The DisposeCTable procedure disposes of the ColorTable record whose handle you pass in the cTable parameter.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetCTable GetCTable Available in OS X v10.0 through OS X v10.6

    Obtains a color table stored in a 'clut' resource.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    CTabHandle GetCTable ( short ctID );

    Parameters

    ctID

    The resource ID of a 'clut' resource.

    Return Value

    A handle to the color table. If the 'clut' resource with that ID is not found, GetCTable returns NULL. Before you place this handle in the pmTable field of a PixMap structure, first use the DisposeCTable function to dispose of the handle already there.

    Discussion

    Before you modify a ColorTable structure, change its ctSeed field to invalidate it. To do this, use the CTabChanged function.

    The GetCTable function recognizes a number of standard 'clut' resource IDs. You can obtain the default grayscale color table for a given pixel depth by calling GetCTable, adding 32 (decimal) to the pixel depth, and passing these values in the ctID parameter:

    • A pixel depth of 1. Pass a resource ID of 33. Color table composition: black, white.

    • A pixel depth of 2. Pass a resource ID of 34. Color table composition: black, 33% gray, 66% gray, white.

    • A pixel depth of 4. Pass a resource ID of 36. Color table composition: black, 14 shades of gray, white.

    • A pixel depth of 8. Pass a resource ID of 40. Color table composition: black, 254 shades of gray, white.

    For full color, obtain the default color tables by adding 64 to the pixel depth and passing these values in the ctID parameter:

    • A pixel depth of 2. Pass a resource ID of 66. Color table composition: black, 50% gray, highlight color, white.

    • A pixel depth of 4. Pass a resource ID of 68. Color table composition: black, 14 colors including the highlight color, white.

    • A pixel depth of 8. Pass a resource ID of 72. Color table composition: black, 254 colors including the highlight color, white.

    Special Considerations

    The GetCTable function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • ClosePicture ClosePicture Available in OS X v10.0 through OS X v10.6

    Completes the collection of drawing commands and picture comments that define your picture.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void ClosePicture ( void );

    Discussion

    The ClosePicture function stops collecting drawing commands and picture comments for the currently open picture. You should perform one and only one call to ClosePicture for every call to the OpenCPicture (or OpenPicture) function.

    The ClosePicture function calls the ShowPen function, balancing the call made by OpenCPicture (or OpenPicture) to the HidePen function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • KillPicture KillPicture Available in OS X v10.0 through OS X v10.6

    Releases the memory occupied by a picture not stored in a 'PICT' resource.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void KillPicture ( PicHandle myPicture );

    Parameters

    myPicture

    A handle to the picture whose memory can be released.

    Discussion

    Use this function only when you are completely finished with a picture.

    Special Considerations

    If you use the Window Manager function SetWindowPic to store a picture handle in the window structure, use the Window Manager function DisposeWindow or CloseWindow to release the memory allocated to the picture. These functions automatically call KillPicture for the picture.

    If the picture is stored in a 'PICT' resource, use the Resource Manager function ReleaseResource instead of KillPicture. The Window Manager functions DisposeWindow and CloseWindow will not delete it. Instead, call ReleaseResource before calling DisposeWindow or CloseWindow.

    The KillPicture function may move or purge memory.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • OpenCPicture OpenCPicture Available in OS X v10.0 through OS X v10.6

    Begins defining a picture in extended version 2 format.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    PicHandle OpenCPicture ( const OpenCPicParams *newHeader );

    Parameters

    newHeader

    An OpenCPicParams structure.

    Return Value

    A handle to a new Picture structure. OpenCPicture collects your subsequent drawing commands in this structure. Use this handle when referring to the picture in subsequent functions, such as the DrawPicture function.

    Discussion

    When defining a picture, you can use all other QuickDraw drawing functions, with the exception of CopyMask, CopyDeepMask, SeedFill, SeedCFill, CalcMask, and CalcCMask. You can also use the PicComment function to include picture comments in your picture definition.

    The OpenCPicture function creates a pictures in the extended version 2 format. This format permits your application to specify resolutions when creating images.

    Use the OpenCPicParams structure you pass in the newHeader parameter to specify the horizontal and vertical resolution for the picture, and specify an optimal bounding rectangle for displaying the picture at this resolution. When you later call the DrawPicture function to play back the saved picture, supply a destination rectangle, and DrawPicture scales the picture so that it is completely aligned with the destination rectangle. To display a picture at a resolution other than that at which it was created, compute an appropriate destination rectangle by scaling its width and height by the following factor:

    scale factor = destination resolution / source resolution

    For example, if a picture was created at 300 dpi and you want to display it at 75 dpi, then your application should compute the destination rectangle width and height as 1/4 of those of the picture’s bounding rectangle.

    The OpenCPicture function calls the HidePen function, so no drawing occurs on the screen while the picture is open (unless you call the ShowPen function just after OpenCPicture, or you called ShowPen previously without balancing it by a call to HidePen).

    After defining the picture, close it by using the ClosePicture function.

    After creating the picture, use the GetPictInfo function to gather information about it. The PictInfo structure returned by GetPictInfo returns the picture’s resolution and optimal bounding rectangle.

    Special Considerations

    When creating a picture, use the ClosePicture function to finish it before you open the Printing Manager with the PrOpen function. There are two main reasons for this. First, you should allow the printing driver to use as much memory as possible. Second, the Printing Manager creates its own type of graphics port, one that replaces the standard QuickDraw drawing operations stored in the grafProcs field of a CGrafPort or GrafPort structure. To avoid unexpected results when creating a picture, draw into a graphics port created with QuickDraw instead of drawing into a printing port created by the Printing Manager.

    After calling OpenCPicture, be sure to finish your picture definition by calling ClosePicture before you call OpenCPicture again. You cannot nest calls to OpenCPicture.

    Always use the ClipRect procedure to specify a clipping region appropriate for your picture before you call OpenCPicture. If you do not use ClipRect to specify a clipping region, OpenCPicture uses the clipping region specified in the current graphics port. If the clipping region is very large (as it is when a graphics port is initialized) and you scale the picture when drawing it, the clipping region can become invalid when DrawPicture scales the clipping region—in which case, your picture will not be drawn.

    The OpenCPicture function may move or purge memory; do not call at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • OpenPicture OpenPicture Available in OS X v10.0 through OS X v10.6

    Creates a picture which allows you to specify resolutions for your pictures.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    PicHandle OpenPicture ( const Rect *picFrame );

    Parameters

    picFrame

    The bounding rectangle for the picture. The DrawPicture function uses this rectangle to scale the picture if you draw it into a destination rectangle of a different size.

    Return Value

    A handle to a new Picture structure. OpenPicture collects your subsequent drawing commands in this structure. Use this handle when referring to the picture in subsequent functions, such as the DrawPicture function.

    Discussion

    The OpenPicture function, which was created for earlier versions of system software, is described here for completeness. Use the OpenPicture function to begin defining a picture.

    The OpenPicture function calls the HidePen function, so no drawing occurs on the screen while the picture is open (unless you call the ShowPen function just after OpenPicture or you called ShowPen previously without balancing it by a call to HidePen).

    The OpenPicture function creates pictures in the version 2 format on computers with Color QuickDraw when the current graphics port is a color graphics port. Pictures created in this format support color drawing operations at 72 dpi. On computers supporting only basic QuickDraw, or when the current graphics port is a basic graphics port, this function creates pictures in version 1 format. Pictures created in version 1 format support only black-and-white drawing operations at 72 dpi.

    When defining a picture, you can use all other QuickDraw drawing functions, with the exception of CopyMask, CopyDeepMask, SeedFill, SeedCFill, CalcMask, and CalcCMask. You can also use the PicComment function to include picture comments in your picture definition.

    After defining the picture, close it by using the ClosePicture function. To draw the picture, use the DrawPicture function.

    Special Considerations

    The version 2 and version 1 picture formats support only 72-dpi resolution. The OpenCPicture function creates pictures in the extended version 2 format. The extended version 2 format, which is created by the OpenCPicture function on all Macintosh computers running System 7, permits your application to specify additional resolutions when creating images.

    Version 1 pictures are limited to 32 KB. You can determine the picture size while it is being formed by calling the Memory Manager function GetHandleSize.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PicComment PicComment Available in OS X v10.0 through OS X v10.6

    Inserts a picture comment into a picture that you are defining or into your printing code.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void PicComment ( short kind, short dataSize, Handle dataHandle );

    Parameters

    kind

    The type of comment.

    dataSize

    Size of any additional data passed in the dataHandle parameter. If no additional data is used, specify 0 in this parameter.

    dataHandle

    A handle to additional data, if used. If no additional data is used, specify NULL in this parameter.

    Discussion

    When used after your application begins creating a picture with the OpenCPicture (or OpenPicture) function, the PicComment function inserts the specified comment into the Picture structure. When sent to a printer driver after your application uses the PrOpenPage function, PicComment passes the data or commands in the specified comment directly to the printer.

    Picture comments contain data or commands for special processing by output devices, such as printers.

    Usually printer drivers process picture comments, but applications can also do so. For your application to process picture comments, it must replace the StdComment function pointed to by the commentProc field of the CQDProcs or QDProcs structure, which in turn is pointed to by the grafProcs field of a CGrafPort or GrafPort structure. The default StdComment function provided by QuickDraw does no comment processing whatsoever. You can use the SetStdCProcs function to assist you in changing the CQDProcs structure, and you can use the SetStdProcs function to assist you in changing the QDProcs structure.

    If you create and process your own picture comments, you should define comments so that they contain information that identifies your application (to avoid using the same comments as those used by Apple or by other third-party products). You should define a comment as an ApplicationComment comment type with a kind value of 100. The first 4 bytes of the data for the comment should specify your application’s signature. You can use the next 2 bytes to identify the type of comment—that is, to specify a kind value to your own application.

    Suppose your application signature were 'WAVE', and you wanted to use the value 128 to identify a kind value to your own application. You would supply values to the kind and data parameters to PicComment as follows:

    kind = 100; data = 'WAVE' [4 bytes] + 128 [2 bytes] + additional data [n bytes]

    Your application can then parse the first 6 bytes of the comment to determine whether and how to process the rest of the data in the comment. It is up to you to publish information about your comments if you wish them to be understood and used by other applications.

    Special Considerations

    These former picture comments are now obsolete: SetGrayLevel, ResourcePS, PostScriptFile, and TextIsPostScript.

    The PicComment function may move or purge memory.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • CopyPixPat CopyPixPat Available in OS X v10.0 through OS X v10.6

    Copies the contents of one pixel pattern to another.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void CopyPixPat ( PixPatHandle srcPP, PixPatHandle dstPP );

    Parameters

    srcPP

    A handle to a source pixel pattern, the contents of which you want to copy.

    dstPP

    A handle to a destination pixel pattern, into which you want to copy the contents of the pixel pattern in the srcPP parameter.

    Discussion

    The CopyPixPat function copies all of the fields in the source PixPat structure, including the contents of the data handle, expanded data handle, expanded map, pixel map handle, and color table.

    Generally, your application should create a pixel pattern in a 'ppat' resource, instead of using this function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • DisposePixPat DisposePixPat Available in OS X v10.0 through OS X v10.6

    Releases the storage allocated to a pixel pattern.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DisposePixPat ( PixPatHandle pp );

    Parameters

    pp

    A handle to the pixel pattern to be disposed of.

    Discussion

    The DisposePixPat function disposes of the data handle, expanded data handle, and pixel map handle allocated to the pixel pattern that you specify in the ppat parameter.

    The DisposePixPat function is also available as the DisposPixPat function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetPixPat GetPixPat Available in OS X v10.0 through OS X v10.6

    Obtains a pixel pattern ('ppat') resource stored in a resource file.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    PixPatHandle GetPixPat ( short patID );

    Parameters

    patID

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

    Return Value

    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 NULL.

    Discussion

    When you are finished with the pixel pattern, use the DisposePixPat function. For more information on the pixel pattern resource, see 'ppat'.

    Pixel patterns can use colors at any pixel depth and can be of any width and height that’s a power of 2. To create a pixel pattern, you typically define it in a 'ppat' resource, which you store in a resource file. To retrieve the pixel pattern stored in a 'ppat' resource, you can use the GetPixPat function.

    Special Considerations

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

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • MakeRGBPat MakeRGBPat Available in OS X v10.0 through OS X v10.6

    Creates the appearance of otherwise unavailable colors on indexed devices.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void MakeRGBPat ( PixPatHandle pp, const RGBColor *myColor );

    Parameters

    pp

    On return, a handle to the generated pixel pattern.

    myColor

    An RGBColor structure that defines the color you want to approximate.

    Discussion

    The MakeRGBPat function generates a PixPat structure that approximates the color you specify in the myColor parameter. For example, if your application draws to an indexed device that supports 4 bits per pixel, you only have 16 colors available if you simply set the foreground color and draw. If you use MakeRGBPat to create a pattern, and then draw using that pattern, you effectively get 125 different colors. If the graphics device has 8 bits per pixel, you effectively get 2197 colors. (More color are theoretically possible; this implementation opted for a fast pattern selection rather than the best possible pattern selection.)

    For a pixel pattern, the (** patMap).bounds field of the PixPat structure always contains the values (0,0,8,8), and the (** patMap).rowbytes field equals 2.

    Because patterns produced with MakeRGBPat aren’t usually solid—they provide a selection of colors by alternating between colors, with up to four colors in a pattern— lines that are only one pixel wide may not look good.

    When MakeRGBPat creates a ColorTable structure, it fills in only the rgb fields of its ColorSpec structures; the value fields are computed at the time the drawing actually takes place, using the current pixel depth for the system.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • NewPixPat NewPixPat Available in OS X v10.0 through OS X v10.6

    Creates a new pixel pattern. Generally, however, your application should create a pixel pattern in a 'ppat' resource.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    PixPatHandle NewPixPat ( void );

    Return Value

    A handle to the new PixPat structure created by the NewPixPat function.

    Discussion

    This function calls the NewPixMap function to allocate the pattern’s PixMap structure and initializes it to the same settings as the pixel map of the current GDevice structure. NewPixPat also sets the pat1Data field of the new PixPat structure to a 50 percent gray pattern. NewPixPat allocates new handles for the PixPat structure’s data, expanded data, expanded map, and color table but does not initialize them instead, your application must initialize them.

    Set the rowBytes, bounds, and pixelSize fields of the pattern’s PixMap structure to the dimensions of the desired pattern. The rowBytes value should be equal to

    (width of bounds) x pixelSize/8

    The rowBytes value need not be even. The width and height of the bounds must be a power of 2. Each scan line of the pattern must be at least 1 byte in length—that is, ([width of bounds] x pixelSize) must be at least 8.

    Your application can explicitly specify the color corresponding to each pixel value with a color table. The color table for the pattern must be placed in the pmTable field in the pattern’s PixMap structure.

    Including the PixPat structure itself, NewPixPat allocates a total of five handles. The sizes of the handles to the PixPat and PixMap structures are the sizes of their respective data structures. The other three handles are initially small in size. Once the pattern is drawn, the size of the expanded data is proportional to the size of the pattern data, but adjusted to the depth of the screen. The color table size is the size of the structure plus 8 bytes times the number of colors in the table.

    When you are finished using the pixel pattern, use the DisposePixPat function to make the memory used by the pixel pattern available again.

    Special Considerations

    The NewPixPat function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • ClosePoly ClosePoly Available in OS X v10.0 through OS X v10.6

    Completes the collection of lines that defines a polygon.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void ClosePoly ( void );

    Discussion

    The ClosePoly function stops collecting line-drawing commands for the currently open polygon and computes the polyBBox field of the Polygon structure. You should call ClosePoly only once for every call to the OpenPoly function.

    The ClosePoly function uses the ShowPen function, balancing the call to the HidePen function made by the OpenPoly function.

    Special Considerations

    The ClosePoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • KillPoly KillPoly Available in OS X v10.0 through OS X v10.6

    Releases the memory occupied by a polygon.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void KillPoly ( PolyHandle poly );

    Parameters

    poly

    A handle to the polygon to dispose of.

    Discussion

    Use KillPoly only when you are completely through with a polygon.

    Special Considerations

    The KillPoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • OffsetPoly OffsetPoly Available in OS X v10.0 through OS X v10.6

    Moves a polygon.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void OffsetPoly ( PolyHandle poly, short dh, short dv );

    Parameters

    poly

    A handle to a polygon to move.

    dh

    The horizontal distance to move the polygon.

    dv

    The vertical distance to move the polygon.

    Discussion

    The OffsetPoly function moves the polygon whose handle you pass in the poly parameter by adding the value you specify in the dh parameter to the horizontal coordinates of its points, and by adding the value you specify in the dv parameter to the vertical coordinates of all points of its region boundary. If the values of dh and dv are positive, the movement is to the right and down; if either is negative, the corresponding movement is in the opposite direction. The region retains its size and shape. This does not affect the screen unless you subsequently call a function to draw the region.

    OffsetPoly is an especially efficient operation, because the data defining a polygon is stored relative to the first point of the polygon and so is not actually changed by OffsetPoly.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • OpenPoly OpenPoly Available in OS X v10.0 through OS X v10.6

    Begins defining a polygon.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    PolyHandle OpenPoly ( void );

    Return Value

    A handle to a new polygon.

    Discussion

    The OpenPoly function starts saving lines for processing as a polygon definition. While a polygon is open, all calls to the Line and LineTo functions affect the outline of the polygon. Only the line endpoints affect the polygon definition; the pattern mode, pattern, and size do not affect it. The OpenPoly function calls the HidePen function, so no drawing occurs on the screen while the polygon is open (unless you call the ShowPen function just after calling OpenPoly, or you called ShowPen previously without balancing it by a call to HidePen).

    A polygon should consist of a sequence of connected lines. The OpenPoly function stores the definition for a polygon in a Polygon structure.

    When a polygon is open, the current graphics port’s polySave field contains a handle to information related to the polygon definition. If you want to temporarily disable the polygon definition, you can save the current value of this field, set the field to NULL, and later restore the saved value to resume the polygon definition.

    Even though the onscreen presentation of a polygon is clipped, the definition of a polygon is not; you can define a polygon anywhere on the coordinate plane.

    When you are finished calling the line-drawing functions that define your polygon, use the ClosePoly function.

    Special Considerations

    Do not call OpenPoly while a region or another polygon is already open.

    Polygons are limited to 64 KB. You can determine the polygon size while it is being formed by calling the Memory Manager function GetHandleSize.

    The OpenPoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • EmptyRect EmptyRect Available in OS X v10.0 through OS X v10.6

    Determines whether a rectangle is an empty rectangle.

    Declaration

    Objective-C

    Boolean EmptyRect ( const Rect *r );

    Parameters

    r

    The rectangle to examine.

    Return Value

    TRUE if the rectangle that you specify in the r parameter is an empty rectangle, FALSE if it is not. A rectangle is considered empty if the bottom coordinate is less than or equal to the top coordinate or if the right coordinate is less than or equal to the left.

    Discussion

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • EqualRect EqualRect Available in OS X v10.0 through OS X v10.6

    Determines whether two rectangles are equal.

    Declaration

    Objective-C

    Boolean EqualRect ( const Rect *rect1, const Rect *rect2 );

    Parameters

    rect1

    The first of two rectangles to compare.

    rect2

    The second of two rectangles to compare.

    Return Value

    TRUE if the rectangles are equal, FALSE if they are not.

    Discussion

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • InsetRect InsetRect Available in OS X v10.0 through OS X v10.6

    Shrinks or expands a rectangle.

    Declaration

    Objective-C

    void InsetRect ( Rect *r, short dh, short dv );

    Parameters

    r

    A pointer to the rectangle to alter.

    dh

    The horizontal distance to move the left and right sides in toward or outward from the center of the rectangle.

    dv

    The vertical distance to move the top and bottom sides in toward or outward from the center of the rectangle.

    Discussion

    The InsetRect function shrinks or expands the rectangle that you specify in the r parameter: the left and right sides are moved in by the amount you specify in the dh parameter; the top and bottom are moved toward the center by the amount you specify in the dv parameter. If the value you pass in dh or dv is negative, the appropriate pair of sides is moved outward instead of inward. The effect is to alter the size by 2*dh horizontally and 2*dv vertically, with the rectangle remaining centered in the same place on the coordinate plane.

    If the resulting width or height becomes less than 1, the rectangle is set to the empty rectangle (0,0,0,0).

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • OffsetRect OffsetRect Available in OS X v10.0 through OS X v10.6

    Moves a rectangle.

    Declaration

    Objective-C

    void OffsetRect ( Rect *r, short dh, short dv );

    Parameters

    r

    A pointer to the rectangle to move.

    dh

    The horizontal distance to move the rectangle.

    dv

    The vertical distance to move the rectangle.

    Discussion

    The OffsetRect function moves the rectangle that you specify in the r parameter by adding the value you specify in the dh parameter to each of its horizontal coordinates and the value you specify in the dv parameter to each of its vertical coordinates. If the dh and dv parameters are positive, the movement is to the right and down; if either is negative, the corresponding movement is in the opposite direction. The rectangle retains its shape and size; it is merely moved on the coordinate plane. The movement does not affect the screen unless you subsequently call a function to draw within the rectangle.

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • Pt2Rect Pt2Rect Available in OS X v10.0 through OS X v10.6

    Determines the smallest rectangle that encloses two given points.

    Declaration

    Objective-C

    void Pt2Rect ( Point pt1, Point pt2, Rect *dstRect );

    Parameters

    pt1

    The first of two points to enclose.

    pt2

    The second of two points to enclose.

    dstRect

    On return, a pointer to the smallest rectangle that can enclose them.

    Discussion

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • PtInRect PtInRect Available in OS X v10.0 through OS X v10.6

    Determines whether a pixel below is enclosed in a rectangle.

    Declaration

    Objective-C

    Boolean PtInRect ( Point pt, const Rect *r );

    Parameters

    pt

    The point to test.

    r

    The rectangle to test.

    Return Value

    TRUE if the pixel below and to the right of the point specified in the pt parameter is enclosed in the rectangle specified in the r parameter. FALSE if it is not.

    Discussion

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • PtToAngle PtToAngle Available in OS X v10.0 through OS X v10.6

    Calculates an angle between a vertical line pointing straight up from the center of a rectangle and a line from the center to a given point.

    Declaration

    Objective-C

    void PtToAngle ( const Rect *r, Point pt, short *angle );

    Parameters

    r

    The rectangle to examine.

    pt

    The point to which an angle is to be calculated.

    angle

    On return, a pointer to the resulting angle.

    The result returned in the angle parameter is specified in degrees from 0 to 359, measured clockwise from 12 o’clock, with 90 at 3 o’clock, 180 at 6 o’clock, and 270 at 9 o’clock. Other angles are measured relative to the rectangle. If the line to the given point goes through the upper-right corner of the rectangle, the angle returned is 45, even if the rectangle is not square if it goes through the lower-right corner, the angle is 135, and so on.

    The angle returned can be used as input to one of the functions that manipulate arcs and wedges, in “Drawing Arcs and Wedges”.

    Discussion

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • SectRect SectRect Available in OS X v10.0 through OS X v10.6

    Determines whether two rectangles intersect.

    Declaration

    Objective-C

    Boolean SectRect ( const Rect *src1, const Rect *src2, Rect *dstRect );

    Parameters

    src1

    The first of two rectangles to test for intersection.

    src2

    The second of two rectangles to test for intersection.

    dstRect

    On return, a pointer to the rectangle marking the intersection of the first two rectangles.

    Return Value

    TRUE if the specified rectangles intersect or FALSE if they do not.

    Discussion

    The SectRect function calculates the rectangle that delineates the intersection of the two rectangles you specify in the src1 and src2 parameters. Rectangles that touch at a line or a point are not considered intersecting, because their intersection rectangle (actually, in this case, an intersection line or point) does not enclose any pixels in the bit image.

    If the rectangles do not intersect, the destination rectangle is set to (0,0,0,0). The SectRect function works correctly even if one of the source rectangles is also the destination.

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • SetRect SetRect Available in OS X v10.0 through OS X v10.6

    Assigns coordinates to a rectangle.

    Declaration

    Objective-C

    void SetRect ( Rect *r, short left, short top, short right, short bottom );

    Parameters

    r

    A pointer to the rectangle to set.

    left

    The horizontal coordinate of the new upper-left corner of the rectangle.

    top

    The vertical coordinate of the new upper-left corner of the rectangle.

    right

    The horizontal coordinate of the new lower-right corner of the rectangle.

    bottom

    The vertical coordinate of the new lower-right corner of the rectangle.

    Discussion

    The SetRect function assigns the coordinates you specify in the left, top, right, and bottom parameters to the rectangle that you specify in the r parameter. This function is provided to help you shorten your program text. If you want a more readable text, at the expense of source text length, you can instead assign integers (or points) directly into the fields of a Rect structure.

    You can use a rectangle to specify locations and sizes for various graphics operations.

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • UnionRect UnionRect Available in OS X v10.0 through OS X v10.6

    Calculates the smallest rectangle that encloses two rectangles.

    Declaration

    Objective-C

    void UnionRect ( const Rect *src1, const Rect *src2, Rect *dstRect );

    Parameters

    src1

    The first of two rectangles to enclose.

    src2

    The second of two rectangles to enclose.

    dstRect

    On return, a pointer to the smallest rectangle that encloses both of the rectangles you specify in the src1 and src2 parameters. One of the source rectangles may also be the destination.

    Discussion

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

  • CloseRgn CloseRgn Available in OS X v10.0 through OS X v10.6

    Organizes a collection of lines and shapes into a region definition.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void CloseRgn ( RgnHandle dstRgn );

    Parameters

    dstRgn

    The handle to the region to close. This handle should be a region handle returned by the NewRgn function.

    Discussion

    The CloseRgn function stops the collection of lines and framed shapes, organizes them into a region definition, and saves the result in the region whose handle you pass in the dstRgn parameter.

    The CloseRgn function does not create the destination region; you must have already allocated space for it by using the OpenRgn function. The CloseRgn function calls the ShowPen function, balancing the call to the HidePen function made by OpenRgn.

    When you no longer need the memory occupied by the region, use the DisposeRgn function.

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Special Considerations

    Regions are limited to 32 KB in size in basic QuickDraw and 64 KB in Color QuickDraw. When you structure drawing operations in an open region, the resulting region description may overflow this limit. Should this happen in Color QuickDraw, the QDError function returns the result code regionTooBigError. Since the resulting region is potentially corrupt, the CloseRgn function returns an empty region if it detects QDError has returned regionTooBigError.

    The CloseRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • CopyRgn CopyRgn Available in OS X v10.0 through OS X v10.6

    Makes a copy of a region.

    Declaration

    Objective-C

    void CopyRgn ( RgnHandle srcRgn, RgnHandle dstRgn );

    Parameters

    srcRgn

    A handle to the region to copy.

    dstRgn

    A handle to the region to receive the copy.

    Discussion

    The CopyRgn function copies the mathematical structure of the region whose handle you pass in the srcRgn parameter into the region whose handle you pass in the dstRgn parameter; that is, CopyRgn makes a duplicate copy of srcRgn. When calling CopyRgn, pass handles that have been returned by the NewRgn function in the srcRgn and dstRgn parameters.

    Once this is done, the region indicated by srcRgn may be altered (or even disposed of) without affecting the region indicated by dstRgn. The CopyRgn function does not create the destination region; space must already have been allocated for it by using the NewRgn function.

    Special Considerations

    The CopyRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • DiffRgn DiffRgn Available in OS X v10.0 through OS X v10.6

    Subtracts one region from another.

    Declaration

    Objective-C

    void DiffRgn ( RgnHandle srcRgnA, RgnHandle srcRgnB, RgnHandle dstRgn );

    Parameters

    srcRgnA

    A handle to the region to subtract from.

    srcRgnB

    A handle to the region to subtract.

    dstRgn

    On return, a handle to the region holding the resulting area. If the first source region is empty, DiffRgn sets the destination to the empty region defined by the rectangle (0,0,0,0).

    The DiffRgn function does not create the destination region; you must have already allocated memory for it by using the NewRgn function.

    The destination region may be one of the source regions, if desired.

    Discussion

    The DiffRgn procedure subtracts the region whose handle you pass in the srcRgnB parameter from the region whose handle you pass in the srcRgnA parameter and places the difference in the region whose handle you pass in the dstRgn parameter. If the first source region is empty, DiffRgn sets the destination to the empty region defined by the rectangle (0,0,0,0).

    The DiffRgn procedure does not create the destination region; you must have already allocated memory for it by using the NewRgn function. The destination region may be one of the source regions, if desired.

    Special Considerations

    The DiffRgn function may temporarily use heap space that’s twice the size of the two input regions.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • DisposeRgn DisposeRgn Available in OS X v10.0 through OS X v10.6

    Releases the memory occupied by a region.

    Declaration

    Objective-C

    void DisposeRgn ( RgnHandle rgn );

    Parameters

    rgn

    A handle to the region to dispose. This handle should be a region handle returned by the NewRgn function.

    Discussion

    Use DisposeRgn only after you are completely through with a region.

    Special Considerations

    The DisposeRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • EmptyRgn EmptyRgn Available in OS X v10.0 through OS X v10.6

    Determines whether a region is empty.

    Declaration

    Objective-C

    Boolean EmptyRgn ( RgnHandle rgn );

    Parameters

    rgn

    A handle to the region to test for emptiness.

    Return Value

    TRUE if the region whose handle you pass in the rgn parameter is an empty region or FALSE if it is not.

    Discussion

    The EmptyRgn function does not create an empty region. To create an empty region, you can perform any of the following operations:

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • EqualRgn EqualRgn Available in OS X v10.0 through OS X v10.6

    Determines whether two regions have identical sizes, shapes, and locations.

    Declaration

    Objective-C

    Boolean EqualRgn ( RgnHandle rgnA, RgnHandle rgnB );

    Parameters

    rgnA

    A handle to the first of two regions to compare.

    rgnB

    A handle to the second of two regions to compare.

    Return Value

    TRUE if the two regions are equal; FALSE if they are not. The two regions must have identical sizes, shapes, and locations to be considered equal. Any two empty regions are always equal.

    Discussion

    The EqualRgn function compares the two regions whose handles you pass in the rgnA and rgnB parameters and returns TRUE if they’re equal or FALSE if they’re not.

    The two regions must have identical sizes, shapes, and locations to be considered equal. Any two empty regions are always equal.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • InsetRgn InsetRgn Available in OS X v10.0 through OS X v10.6

    Shrinks or expands a region.

    Declaration

    Objective-C

    void InsetRgn ( RgnHandle rgn, short dh, short dv );

    Parameters

    rgn

    A handle to the region to alter.

    dh

    The horizontal distance to move points on the left and right boundaries in toward or outward from the center.

    dv

    The vertical distance to move points on the top and bottom boundaries in toward or outward from the center.

    Discussion

    The InsetRgn function moves all points on the region boundary of the region whose handle you pass in the rgn parameter inward by the vertical distance that you specify in the dv parameter and by the horizontal distance that you specify in the dh parameter. If you specify negative values for dh or dv, the InsetRgn function moves the points outward in that direction.

    The InsetRgn function leaves the region’s center at the same position, but moves the outline in (for positive values of dh and dv) or out (for negative values of dh and dv). Using InsetRgn on a rectangular region has the same effect as using the InsetRect function.

    Special Considerations

    The InsetRgn function temporarily uses heap space that’s twice the size of the original region.

    The InsetRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • NewRgn NewRgn Available in OS X v10.0 through OS X v10.6

    Begins creating a new region.

    Declaration

    Objective-C

    RgnHandle NewRgn ( void );

    Return Value

    A handle to the new region.

    Discussion

    The NewRgn function allocates space for a new, variable-size region and initializes it to the empty region defined by the rectangle (0,0,0,0). This is the only function that creates a new region; other functions merely alter the size or shape of existing regions.

    To begin defining a region, use the OpenRgn function.

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Special Considerations

    The NewRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Use the Memory Manager function MaxMem to determine whether the memory for the region is valid before using NewRgn.

    Ensure that the memory for a region is valid before calling this function to manipulate that region if there isn’t sufficient memory, the system may crash. Regions are limited to 32 KB in size in basic QuickDraw and 64 KB in color QuickDraw. Before defining a region, you can use the Memory Manager function MaxMem to determine whether the memory for the region is valid. You can determine the current size of an existing region by calling the Memory Manager function GetHandleSize. When you record drawing operations in an open region, the resulting region description may overflow the 32 KB or 64 KB limit. Should this happen in color QuickDraw, the QDError function returns the result code regionTooBigError.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • OffsetRgn OffsetRgn Available in OS X v10.0 through OS X v10.6

    Moves a region.

    Declaration

    Objective-C

    void OffsetRgn ( RgnHandle rgn, short dh, short dv );

    Parameters

    rgn

    A handle to the region to move.

    dh

    The horizontal distance to move the region.

    dv

    The vertical distance to move the region.

    Discussion

    The OffsetRgn function moves the region whose handle you pass in the rgn parameter by adding the value you specify in the dh parameter to the horizontal coordinates of all points of its region boundary, and by adding the value you specify in the dv parameter to the vertical coordinates of all points of its region boundary. If the values of dh and dv are positive, the movement is to the right and down; if either is negative, the corresponding movement is in the opposite direction. The region retains its size and shape. This does not affect the screen unless you subsequently call a function to draw the region.

    The OffsetRgn function is an especially efficient operation, because most of the data defining a region is stored relative to the rgnBBox field in its Region structure and so is not actually changed by OffsetRgn.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • OpenRgn OpenRgn Available in OS X v10.0 through OS X v10.6

    Begins defining a region.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void OpenRgn ( void );

    Discussion

    The OpenRgn function allocates temporary memory to start saving lines and framed shapes for processing as a region definition. Call OpenRgn only after initializing a region with the NewRgn function.

    The NewRgn function stores the definition for a region in a Region structure.

    While a region is open, all calls to Line, LineTo, and the functions that draw framed shapes (except arcs) affect the outline of the region. Only the line endpoints and shape boundaries affect the region definition—the pattern mode, pattern, and size do not affect it.

    When you are finished defining the region, call the CloseRgn function.

    The OpenRgn function calls HidePen, so no drawing occurs on the screen while the region is open (unless you call ShowPen just after OpenRgn, or you called ShowPen previously without balancing it by a call to HidePen). Since the pen hangs below and to the right of the pen location, drawing lines with even the smallest pen changes pixels that lie outside the region you define.

    The outline of a region is mathematically defined and infinitely thin, and it separates the bit or pixel image into two groups of pixels: those within the region and those outside it.

    A region should consist of one or more closed loops. Each framed shape itself constitutes a loop. Any lines drawn with the Line or LineTo function should connect with each other or with a framed shape. Even if the onscreen presentation of a region is clipped, the definition of a region is not; you can define a region anywhere on the coordinate plane with complete disregard for the location of various graphics port entities on that plane.

    When a region is open, the current graphics port’s rgnSave field contains a handle to information related to the region definition. If you want to temporarily disable the collection of lines and shapes, you can save the current value of this field, set the field to NULL, and later restore the saved value to resume the region definition. Also, calling SetPort while a region is being formed discontinues formation of the region until another call to SetPort resets the region’s original graphics port.

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Special Considerations

    Regions are limited to 32 KB in size in basic QuickDraw and 64 KB in Color QuickDraw. You can determine the current size of an existing region by calling the Memory Manager function GetHandleSize. When you structure drawing operations in an open region, the resulting region description may overflow the 32 KB or 64 KB limit. Should this happen in Color QuickDraw, the QDError function returns the result code regionTooBigError.

    Do not call OpenRgn while another region or a polygon is already open. When you are finished constructing the region, use the CloseRgn function, which is described next.

    The OpenRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PtInRgn PtInRgn Available in OS X v10.0 through OS X v10.6

    Determines whether a pixel is within a region.

    Declaration

    Objective-C

    Boolean PtInRgn ( Point pt, RgnHandle rgn );

    Parameters

    pt

    The point whose pixel is to be checked.

    rgn

    A handle to the region to test.

    Return Value

    TRUE if the pixel below and to the right of the point specified in the pt parameter is within the region whose handle is specified in the rgn parameter. FALSE if it is not.

    Discussion

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • RectInRgn RectInRgn Available in OS X v10.0 through OS X v10.6

    Determines whether a rectangle intersects a region.

    Declaration

    Objective-C

    Boolean RectInRgn ( const Rect *r, RgnHandle rgn );

    Parameters

    r

    The rectangle to check for intersection.

    rgn

    A handle to the region to check.

    Return Value

    TRUE if the rectangle specified in the r parameter intersects the region whose handle is specified in the rgn parameter. The RectInRgn function returns TRUE if the intersection encloses at least 1 bit or FALSE if it does not.

    Discussion

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Special Considerations

    The RectInRgn function sometimes returns TRUE when the rectangle merely intersects the region’s bounding rectangle. If you need to know exactly whether a given rectangle intersects the actual region, use RectRgn to set the rectangle to a region, and call SectRgn to see whether the two regions intersect. If the result of SectRgn is an empty region, then the rectangle does not intersect the region.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • RectRgn RectRgn Available in OS X v10.0 through OS X v10.6

    Changes the structure of an existing region to that of a rectangle.

    Declaration

    Objective-C

    void RectRgn ( RgnHandle rgn, const Rect *r );

    Parameters

    rgn

    A handle to the region to restructure as a rectangle.

    r

    The rectangle structure to use.

    Discussion

    The RectRgn function destroys the previous structure of the SetRectRgn function, and it then sets the new structure to a rectangle that you specify in the r parameter.

    As an alternative to the RectRgn function, use the SetRectRgn function, which accepts as parameters four coordinates instead of a rectangle.

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Special Considerations

    The RectRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • SectRgn SectRgn Available in OS X v10.0 through OS X v10.6

    Calculates the intersection of two regions.

    Declaration

    Objective-C

    void SectRgn ( RgnHandle srcRgnA, RgnHandle srcRgnB, RgnHandle dstRgn );

    Parameters

    srcRgnA

    A handle to the first of two regions whose intersection is to be determined.

    srcRgnB

    A handle to the second of two regions whose intersection is to be determined.

    dstRgn

    On return, a handle to the region holding the intersection area. If the regions do not intersect, or one of the regions is empty, SectRgn sets the destination to the empty region defined by the rectangle (0,0,0,0).

    The SectRgn function does not create a destination region; you must have already allocated memory for it by using the NewRgn function.

    The destination region may be one of the source regions, if desired.

    Discussion

    The SectRgn procedure calculates the intersection of the two regions whose handles you pass in the srcRgnA and srcRgnB parameters, and it places the intersection in the region whose handle you pass in the dstRgn parameter. If the regions do not intersect, or one of the regions is empty, SectRgn sets the destination to the empty region defined by the rectangle (0,0,0,0).

    The SectRgn procedure does not create a destination region; you must have already allocated memory for it by using the NewRgn function.

    The destination region may be one of the source regions, if desired.

    Special Considerations

    The SectRgn function may temporarily use heap space that’s twice the size of the two input regions.

    The SectRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • SetEmptyRgn SetEmptyRgn Available in OS X v10.0 through OS X v10.6

    Sets an existing region to be empty.

    Declaration

    Objective-C

    void SetEmptyRgn ( RgnHandle rgn );

    Parameters

    rgn

    A handle to the region to be made empty.

    Discussion

    The SetEmptyRgn function destroys the previous structure of the region whose handle you pass in the rgn parameter; it then sets the new structure to the empty region defined by the rectangle (0,0,0,0).

    Special Considerations

    The SetEmptyRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • SetRectRgn SetRectRgn Available in OS X v10.0 through OS X v10.6

    Changes the structure of an existing region to that of a rectangle.

    Declaration

    Objective-C

    void SetRectRgn ( RgnHandle rgn, short left, short top, short right, short bottom );

    Parameters

    rgn

    A handle to the region to restructure as a rectangle.

    left

    The horizontal coordinate of the upper-left corner of the rectangle to set as the new region.

    top

    The vertical coordinate of the upper-left corner of the rectangle to set as the new region.

    right

    The horizontal coordinate of the lower-right corner of the rectangle to set as the new region.

    bottom

    The vertical coordinate of the lower-right corner of the rectangle to set as the new region.

    Discussion

    The SetRectRgn function destroys the previous structure of the region whose handle you pass in the rgn parameter, and it then sets the new structure to the rectangle that you specify in the left, top, right, and bottom parameters. If you specify an empty rectangle (that is, right is greater than or equal to left or bottom = top), the SetRectRgn function sets the region to the empty region defined by the rectangle (0,0,0,0).

    As an alternative to the SetRectRgn function, you can change the structure of an existing region to that of a rectangle by using the RectRgn function, which accepts as a parameter a rectangle instead of four coordinates.

    If the points or rectangles supplied to this function are defined in a graphics port other than your current graphics port, you must convert them to the local coordinate system of your current graphics port. You can accomplish this by using the SetPort function to change to the graphics port containing the points or rectangles, using the LocalGlobal function to convert their locations to global coordinates, using SetPort to return to your starting graphics port, and then using the GlobalToLocal function to convert the locations of points or rectangles to the local coordinates of your current graphics port.

    Special Considerations

    The SetRectRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • UnionRgn UnionRgn Available in OS X v10.0 through OS X v10.6

    Calculates the union of two regions.

    Declaration

    Objective-C

    void UnionRgn ( RgnHandle srcRgnA, RgnHandle srcRgnB, RgnHandle dstRgn );

    Parameters

    srcRgnA

    A handle to the first of two regions whose union is to be determined.

    srcRgnB

    A handle to the second of two regions whose union is to be determined.

    dstRgn

    On return, a handle to the region holding the resulting union area. If both regions are empty, UnionRgn sets the destination to the empty region defined by the rectangle (0,0,0,0).

    The UnionRgn function does not create the destination region; you must have already allocated memory for it by using the NewRgn function.

    The destination region may be one of the source regions, if desired.

    Discussion

    The UnionRgn procedure calculates the union of the two regions whose handles you pass in the srcRgnA and srcRgnB parameters, and it places the union in the region whose handle you pass in the dstRgn parameter. If both regions are empty, UnionRgn sets the destination to the empty region defined by the rectangle (0,0,0,0).

    Special Considerations

    The UnionRgn function may temporarily use heap space that’s twice the size of the two input regions.

    The UnionRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • XorRgn XorRgn Available in OS X v10.0 through OS X v10.6

    Calculates the difference between the union and the intersection of two regions.

    Declaration

    Objective-C

    void XorRgn ( RgnHandle srcRgnA, RgnHandle srcRgnB, RgnHandle dstRgn );

    Parameters

    srcRgnA

    A handle to the first of two regions to compare.

    srcRgnB

    A handle to the second of two regions to compare.

    dstRgn

    On return, a handle to the region holding the result.

    This does not create the destination region; you must have already allocated memory for it by using the NewRgn function.

    If the regions are coincident, XorRgn sets the destination region to the empty region defined by the rectangle (0,0,0,0).

    Discussion

    The XorRgn procedure calculates the difference between the union and the intersection of the regions whose handles you pass in the srcRgnA and srcRgnB parameters and places the result in the region whose handle you pass in the dstRgn parameter.

    Special Considerations

    The XorRgn function may temporarily use heap space that’s twice the size of the two input regions.

    The XorRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • DisposeGDevice DisposeGDevice Available in OS X v10.0 through OS X v10.6

    Disposes of a GDevice structure, releases the space allocated for it, and disposes of all the data structures allocated for it.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DisposeGDevice ( GDHandle gdh );

    Parameters

    gdh

    A handle to the GDevice structure.

    Discussion

    Generally, you should never need to use this function. Color QuickDraw calls this function when appropriate. The DisposeGDevice function is also available as the DisposGDevice function.

    When your application uses the DisposeGWorld function to dispose of an offscreen graphics world, DisposeGDevice disposes of its GDevice structure.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • InitGDevice InitGDevice Available in OS X v10.0 through OS X v10.6

    Initializes a GDevice structure.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void InitGDevice ( short qdRefNum, long mode, GDHandle gdh );

    Parameters

    qdRefNum

    Reference number of the graphics device. System software sets this number at system startup time for most graphics devices.

    mode

    The device configuration mode. Used by the screen driver, this value sets the pixel depth and specifies color or black and white.

    gdh

    The handle, returned by the NewGDevice function, to the GDevice structure to be initialized.

    Discussion

    The InitGDevice function sets the graphics device whose driver has the reference number specified in the gdRefNum parameter to the mode specified in the mode parameter. The InitGDevice function then fills out the GDevice structure, previously created with the NewGDevice function, to contain all information describing that mode.

    The mode parameter determines the configuration of the device. Possible modes for a device are determined by interrogating the video device’s ROM through Slot Manager functions. The information describing the device’s mode is primarily contained in the video device’s ROM. If the video device has a fixed color table, then that table is read directly from the ROM. If the video device has a variable color table, then InitGDevice uses the default color table defined in a 'clut' resource, contained in the System file, that has a resource ID equal to the video device’s pixel depth.

    In general, your application should never need to call InitGDevice. All video devices are initialized at start time, and users change modes through the Monitors control panel.

    If your program uses NewGDevice to create a graphics device without a driver, InitGDevice does nothing; instead, your application must initialize all fields of the GDevice structure. After your application initializes the color table for the GDevice structure, call the Color Manager function MakeITable to build the inverse table for the graphics device.

    Special Considerations

    The InitGDevice function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • NewGDevice NewGDevice Available in OS X v10.0 through OS X v10.6

    Creates a new GDevice structure.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    GDHandle NewGDevice ( short refNum, long mode );

    Parameters

    refNum

    Reference number of the graphics device for which you are creating a GDevice structure. For most video devices, this information is set at system startup.

    mode

    The device configuration mode. Used by the screen driver, this value sets the pixel depth and specifies color or black and white.

    Return Value

    A handle to the new GDevice structure. If the request is unsuccessful, NewGDevice returns NULL.

    Discussion

    Generally, you do not need to use NewGDevice, because Color QuickDraw uses this function to create GDevice structures for your application automatically. When the system starts up, it allocates and initializes one handle to a GDevice structure for each video device it finds. When you use the NewGWorld function, QuickDraw automatically creates a GDevice structure for the new offscreen graphics world.

    For the graphics device whose driver is specified in the refNum parameter and whose mode is specified in the mode parameter, the NewGDevice function allocates a new GDevice structure and all of its handles, and then calls the InitGDevice function to initialize the structure.

    NewGDevice allocates the new GDevice structure and all of its handles in the system heap, and the NewGDevice function sets all attributes in the gdFlags field of the GDevice structure to FALSE. If your application creates a GDevice structure, use the SetDeviceAttribute function to change the flag bits in the gdFlags field of the GDevice structure to TRUE. Your application should never directly change the gdFlags field of the GDevice structure. Instead, use only the SetDeviceAttribute function.

    If your application creates a GDevice structure without a driver, set the mode parameter to –1. In this case, InitGDevice cannot initialize the GDevice structure, so your application must perform all initialization of the structure. A GDevice structure’s default mode is defined as 128. This is assumed to be a black-and-white mode. If you specify a value other than 128 in the mode parameter, the structure’s gdDevType bit in the gdFlags field of the GDevice structure is set to TRUE to indicate that the graphics device is capable of displaying color.

    The NewGDevice function does not automatically insert the GDevice structure into the device list. In general, your application should not create GDevice structures, and if it ever does, it should never add them to the device list.

    If your program uses NewGDevice to create a graphics device without a driver, InitGDevice does nothing; instead, your application must initialize all fields of the GDevice structure. After your application initializes the color table for the GDevice structure, call the Color Manager function MakeITable to build the inverse table for the graphics device.

    Special Considerations

    The NewGDevice function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SetDeviceAttribute SetDeviceAttribute Available in OS X v10.0 through OS X v10.6

    Sets the attribute bits of a GDevice structure.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SetDeviceAttribute ( GDHandle gdh, short attribute, Boolean value );

    Parameters

    gdh

    A handle to a GDevice structure.

    attribute

    One of the specific constants, which represent bits in the gdFlags field of a GDevice structure. See GDevice for the values you can use in this parameter.

    value

    A value of either 0 or 1 for the flag bit specified in the attribute parameter.

    Discussion

    For the graphics device specified in the gdh parameter, the SetDeviceAttribute function sets the flag bit specified in the attribute parameter to the value specified in the value parameter.

    Your application should never directly change the gdFlags field of the GDevice structure; instead, use only the SetDeviceAttribute function.

    Special Considerations

    The SetDeviceAttribute function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SetGDevice SetGDevice Available in OS X v10.0 through OS X v10.6

    Sets a GDevice structure as the current device.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SetGDevice ( GDHandle gd );

    Parameters

    gd

    A handle to a GDevice structure.

    Discussion

    Your application won’t generally need to use this function, because when your application draws into a window on one or more screens, Color QuickDraw automatically switches GDevice structures as appropriate; and when your application needs to draw into an offscreen graphics world, it can use the SetGWorld function to set the graphics port as well as the GDevice structure for the offscreen environment. However, if your application uses the SetPort function instead of the SetGWorld function to set the graphics port to or from an offscreen graphics world, then your application must use SetGDevice in conjunction with SetPort.

    A handle to the currently active device is kept in the global variable TheGDevice.

    Special Considerations

    The SetGDevice function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • CopyPixMap CopyPixMap Available in OS X v10.0 through OS X v10.6

    Duplicates a PixMap structure.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void CopyPixMap ( PixMapHandle srcPM, PixMapHandle dstPM );

    Parameters

    srcPM

    A handle to the PixMap structure to be copied.

    dstPM

    On return, a handle to the duplicated PixMap structure.

    Discussion

    Typically, you do not need to call this function in your application code, because the CopyPixMap function copies the contents of the source PixMap structure to the destination PixMap structure. The contents of the color table are copied, so the destination PixMap has its own copy of the color table. Because the baseAddr field of the PixMap structure is a pointer, the pointer, but not the image itself, is copied.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • DisposePixMap DisposePixMap Available in OS X v10.0 through OS X v10.6

    Disposes a PixMap structure and its color table.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DisposePixMap ( PixMapHandle pm );

    Parameters

    pm

    A handle to the PixMap structure to be disposed of.

    Discussion

    The CloseCPort function calls DisposePixMap.

    Your application typically does not need to call this function. This function is also available as DisposPixMap.

    If your application uses DisposePixMap, take care that it does not dispose of a PixMap structure whose color table is the same as the current device’s CLUT.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • NewPixMap NewPixMap Available in OS X v10.0 through OS X v10.6

    Creates a new, initialized PixMap structure.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    PixMapHandle NewPixMap ( void );

    Return Value

    A handle to the new PixMap structure.

    Discussion

    All fields of the PixMap structure are copied from the current device’s PixMap structure except the color table. In System 7, the hRes and vRes fields are set to 72 dpi, no matter what values the current device’s PixMap structure contains. A handle to the color table is allocated but not initialized.

    Typically, you do not need to call this function because PixMap structures are created for you when you create a window using the Window Manager functions NewCWindow and GetNewCWindow and when you create an offscreen graphics world with the NewGWorld function.

    If your application creates a pixel map, your application must initialize the PixMap structure’s color table to describe the pixels. Use the GetCTable function to read such a table from a resource file. Use the DisposeCTable function to dispose of the PixMap structure’s color table and replace it with the one returned by GetCTable.

    Special Considerations

    The NewPixMap function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SetPortPix SetPortPix Available in OS X v10.0 through OS X v10.6

    Sets the pixel map for the current color graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SetPortPix ( PixMapHandle pm );

    Parameters

    pm

    A handle to the PixMap structure.

    Discussion

    The SetPortPix function replaces the portPixMap field of the current CGrafPort structure with the handle you specify in the pm parameter.

    Typically, your application does not need to call this function.

    The SetPortPix function is analogous to the basic QuickDraw function SetPortBits, which sets the bitmap for the current basic graphics port. The SetPortPix function has no effect when used with a basic graphics port. Similarly, SetPortBits has no effect when used with a color graphics port.

    Both SetPortPix and SetPortBits allow you to perform drawing and calculations on a buffer other than the screen. However, instead of using these functions, use the offscreen graphics capabilities.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SetStdCProcs SetStdCProcs Available in OS X v10.0 through OS X v10.6

    Obtains a CQDProcs structure with fields that point to QuickDraw’s standard low-level functions, which you can modify to change QuickDraw’s standard low-level behavior.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SetStdCProcs ( CQDProcs *procs );

    Parameters

    procs

    Upon completion, a CQDProcs structure with fields that point to QuickDraw’s standard low-level functions. You can change one or more fields to point to your own functions and then set the color graphics port to use this modified CQDProcs structure.

    Discussion

    For each shape that QuickDraw can draw, certain functions perform basic graphics operations on the shape: framing, painting, erasing, inverting, and filling. These functions, in turn, call a low-level drawing function for the shape.

    The grafProcs field determines which low-level functions are called. If that field contains a value of NULL, the standard functions are called. You can set the grafProcs field to point to a structure of pointers to your own functions, and either completely override the standard ones or call them after your functions have modified their parameters as necessary.

    The SetStdCProcs function sets all the fields of the CQDProcs structure to point to the standard functions. You can then reset the ones with which you are concerned.

    The functions you install in the CDQProcs structure must have the same calling sequences as the standard basic QuickDraw functions.

    When drawing in a color graphics port, your application must always use SetStdCProcs instead of SetStdProcs.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SetStdProcs SetStdProcs Available in OS X v10.0 through OS X v10.6

    Obtains a QDProcs structure with fields that point to basic QuickDraw’s standard low-level functions, which you can modify to point to your own functions.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SetStdProcs ( QDProcs *procs );

    Parameters

    procs

    On return, a pointer to a QDProcs structure with fields that point to basic QuickDraw’s standard low-level functions. You can change one or more fields of this structure to point to your own functions and then set the basic graphics port to use this modified QDProcs structure. By changing these pointers, you can install your own functions, and either completely override the standard ones or call them after your functions have modified their parameters as necessary.

    Discussion

    The functions you install in this QDProcs structure must have the same calling sequences as the standard functions.

    Special Considerations

    The Color QuickDraw function SetStdCProcs is analogous to the SetStdProcs function, which you should use with computers that support only basic QuickDraw. When drawing in a color graphics port, your application must always use SetStdCProcs instead of SetStdProcs.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdArc StdArc Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for drawing an arc or a wedge.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdArc ( GrafVerb verb, const Rect *r, short startAngle, short arcAngle );

    Parameters

    verb

    The action to perform. See Verb Constants.

    r

    The rectangle to contain the arc.

    startAngle

    The beginning angle.

    arcAngle

    The ending angle.

    Discussion

    Using the action specified in the verb parameter, the StdArc function draws an arc or wedge of the oval that fits inside the rectangle specified in the r parameter. The arc or wedge is bounded by the radii specified in the startAngle and arcAngle parameters.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdArc function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdBits StdBits Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for transferring bits and pixels.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdBits ( const BitMap *srcBits, const Rect *srcRect, const Rect *dstRect, short mode, RgnHandle maskRgn );

    Parameters

    srcBits

    A pointer to a bitmap or pixel map containing the image to copy.

    srcRect

    A pointer to the source rectangle.

    dstRect

    The destination rectangle.

    mode

    The source mode for the copy.

    maskRgn

    A handle to a region acting as a mask for the transfer.

    Discussion

    The StdBits function transfers a bit or pixel image between the bitmap or pixel map specified in the srcBits parameter and bitmap of the current graphics port, just as if the CopyBits function were called with the same parameters and with a destination bitmap equal to (* thePort).portBits.

    You should only call this low-level function from your customized QuickDraw functions.

    See CopyBits for a discussion of the destination bitmap and of the srcBits, srcRect, dstRect, mode, and maskRgn parameters

    Special Considerations

    The StdBits function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdComment StdComment Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for processing a picture comment.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdComment ( short kind, short dataSize, Handle dataHandle );

    Parameters

    kind

    The type of comment.

    dataSize

    The size of additional data, in bytes.

    dataHandle

    A handle to additional data.

    Discussion

    If there’s no additional data for the comment, the value of the dataHandle parameter is NULL and the value of the dataSize parameter is 0. The StdComment function simply ignores the comment.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdComment function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdGetPic StdGetPic Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for retrieving information from the definition of a picture.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdGetPic ( void *dataPtr, short byteCount );

    Parameters

    dataPtr

    On return, a pointer to the collected picture data.

    byteCount

    The size of the picture data.

    Discussion

    The StdGetPic function retrieves from the definition of the currently open picture the next number of bytes as specified in the byteCount parameter.

    You should only call this low-level function from your customized QuickDraw functions.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdLine StdLine Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for drawing a line.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdLine ( Point newPt );

    Parameters

    newPt

    The point to which to draw the line.

    Discussion

    The StdLine function draws a line from the current pen location to the location (in local coordinates) specified in the newPt parameter.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdLine function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdOval StdOval Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for drawing an oval.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdOval ( GrafVerb verb, const Rect *r );

    Parameters

    verb

    The action to perform. See Verb Constants.

    r

    The rectangle to contain the oval.

    Discussion

    The StdOval function draws an oval inside the given rectangle specified in the r parameter according to the action specified in the verb parameter.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdOval function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdPoly StdPoly Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for drawing a polygon.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdPoly ( GrafVerb verb, PolyHandle poly );

    Parameters

    verb

    The action to perform. See Verb Constants.

    poly

    A handle to the polygon data.

    Discussion

    The StdPoly function draws the polygon specified in the poly parameter according to the action specified in the verb parameter.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdPoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdPutPic StdPutPic Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for saving information as the definition of a picture.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdPutPic ( const void *dataPtr, short byteCount );

    Parameters

    dataPtr

    A pointer to the collected picture data.

    byteCount

    The size of the picture data.

    Discussion

    The StdPutPic function saves as the definition of the currently open picture the drawing commands stored in the data structure pointed to by the dataPtr parameter, starting with the first byte and continuing for the next number of bytes as specified in the byteCount parameter.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdPutPic function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdRect StdRect Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for drawing a rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdRect ( GrafVerb verb, const Rect *r );

    Parameters

    verb

    The action to perform. See Verb Constants.

    r

    The rectangle to draw.

    Discussion

    The StdRect function draws the rectangle specified in the r parameter according to the action specified in the verb parameter.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdRgn StdRgn Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for drawing a region.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdRgn ( GrafVerb verb, RgnHandle rgn );

    Parameters

    verb

    The action to perform. See Verb Constants.

    rgn

    A handle to the region data.

    Discussion

    The StdRgn function draws the region specified in the rgn parameter according to the action specified in the verb parameter.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • StdRRect StdRRect Available in OS X v10.0 through OS X v10.6

    QuickDraw’s standard low-level function for drawing a rounded rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void StdRRect ( GrafVerb verb, const Rect *r, short ovalWidth, short ovalHeight );

    Parameters

    verb

    The action to perform. See Verb Constants.

    r

    The rectangle to draw.

    ovalWidth

    The width diameter for the corner oval.

    ovalHeight

    The height diameter for the corner oval.

    Discussion

    The StdRRect function draws the rounded rectangle specified in the r parameter according to the action specified in the verb parameter. The ovalWidth and ovalHeight parameters specify the diameters of curvature for the corners.

    You should only call this low-level function from your customized QuickDraw functions.

    Special Considerations

    The StdRRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetBackColor GetBackColor Available in OS X v10.0 through OS X v10.6

    Obtains the background color of the current graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void GetBackColor ( RGBColor *color );

    Parameters

    color

    On return, the RGBColor structure for the current background color.

    Discussion

    This function operates for graphics ports defined by both the GrafPort and CGrafPort structures. If the current graphics port is defined by a CGrafPort structure, the returned value is taken directly from the rgbBkColor field.

    If the current graphics port is defined by a GrafPort structure, then only eight possible colors can be returned. These eight colors are determined by the values in a global variable named QDColors, which is a handle to a color table containing the current QuickDraw colors.

    Use the RGBBackColor function to change the background color.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetCPixel GetCPixel Available in OS X v10.0 through OS X v10.6

    Determines the color of an individual pixel specified in the h and v parameters.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void GetCPixel ( short h, short v, RGBColor *cPix );

    Parameters

    h

    The horizontal coordinate of the point at the upper-left corner of the pixel.

    v

    The vertical coordinate of the point at the upper-left corner of the pixel.

    cPix

    On return, the RGBColor structure for the pixel color.

    Discussion

    Use the SetCPixel function to change the color of this pixel.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetForeColor GetForeColor Available in OS X v10.0 through OS X v10.6

    Obtains the color of the foreground color for the current graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void GetForeColor ( RGBColor *color );

    Parameters

    color

    On return, the RGBColor structure for the current foreground color.

    Discussion

    This function operates for graphics ports defined by both the GrafPort and CGrafPort structures. If the current graphics port is defined by a CGrafPort structure, the returned value is taken directly from the rgbFgColor field.

    If the current graphics port is defined by a GrafPort structure, then only eight possible RGB values can be returned. These eight values are determined by the values in a global variable named QDColors, which is a handle to a color table containing the current QuickDraw colors.

    Use the RGBForeColor function to change the foreground color.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • DeviceLoop DeviceLoop Available in OS X v10.0 through OS X v10.6

    Draws images that are optimized for every screen they cross.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DeviceLoop ( RgnHandle drawingRgn, DeviceLoopDrawingUPP drawingProc, long userData, DeviceLoopFlags flags );

    Parameters

    drawingRgn

    A handle to the region in which you will draw; this drawing region uses coordinates that are local to its graphics port.

    drawingProc

    A pointer to your own drawing function.

    userData

    Any additional data that you wish to supply to your drawing function.

    flags

    One or more members of the set of flags defined by the Device Loop Flags data type. if you want to use the default behavior of DeviceLoop, specify an empty set ([]) in this parameter.

    Discussion

    The DeviceLoop function searches for graphics devices that intersect your window’s drawing region, and it calls your drawing function for each dissimilar video device it finds.

    Because DeviceLoop provides your drawing function with the pixel depth and other attributes of each video device, your drawing function can optimize its drawing for each video device.

    See DeviceLoopDrawingProcPtr for a description of the drawing function you must provide for the drawingProc parameter.

    Special Considerations

    The DeviceLoop function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • ScreenRes ScreenRes Available in OS X v10.0 through OS X v10.6

    Determines the resolution of the main device.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void ScreenRes ( short *scrnHRes, short *scrnVRes );

    Parameters

    scrnHRes

    On return, the number of horizontal pixels per inch displayed by the current device.

    scrnVRes

    On return, the number of vertical pixels per inch displayed by the current device.

    Discussion

    To determine the resolutions of all available graphics devices, examine their GDevice structures. The horizontal and vertical resolutions for a graphics device are stored in the hRes and vRes fields, respectively, of the PixMap structure for the device’s GDevice structure.

    Currently, QuickDraw and the Printing Manager always assume a screen resolution of 72 dpi.

    Do not use the actual screen resolution as a scaling factor when drawing into a printing graphics port. Instead, always use 72 dpi as the scaling factor. See the Printing Manager documentation for more information about drawing into a printing graphics port.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • TestDeviceAttribute TestDeviceAttribute Available in OS X v10.0 through OS X v10.6

    Determines whether the flag bit for an attribute has been set in the gdFlags field of a GDevice structure.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    Boolean TestDeviceAttribute ( GDHandle gdh, short attribute );

    Parameters

    gdh

    A handle to a GDevice structure.

    attribute

    One of the specific constants, which represent bits in the gdFlags field of a GDevice structure. See Device Attribute Constants for a description of the values you can use in this parameter.

    Return Value

    TRUE if the bit of the graphics device attribute specified in the attribute parameter is set to 1. Otherwise, TestDeviceAttribute returns FALSE.

    Discussion

    Use the SetDeviceAttribute function to change any of the flags tested by the TestDeviceAttribute function.

    Special Considerations

    The TestDeviceAttribute function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • QDDone QDDone Available in OS X v10.0 through OS X v10.6

    Determines whether QuickDraw has completed drawing in a given graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    Boolean QDDone ( GrafPtr port );

    Parameters

    port

    The GrafPort structure for a graphics port in which your application has begun drawing; if you pass NULL, QDDone tests all open graphics ports.

    Return Value

    TRUE if all drawing operations have finished in the graphics port specified in the port parameter, FALSE if any remain to be executed. If you pass NULL in the port parameter, then QDDone returns TRUE only if drawing operations have completed in all ports.

    Discussion

    The QDDone function may be useful if a graphics accelerator is present and operating asynchronously. You can use it to ensure that all drawing is done before issuing new drawing commands, and to avoid the possibility that the new drawing operations might be overlaid by previously issued but unexecuted operations.

    Special Considerations

    If a graphics port draws a clock or some other continuously operating drawing process, QDDone may never return TRUE.

    To determine whether all drawing in a color graphics port has completed, you must coerce its CGrafPort structure to a GrafPort structure, which you pass in the port parameter.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • EraseArc EraseArc Available in OS X v10.0 through OS X v10.6

    Erases a wedge.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void EraseArc ( const Rect *r, short startAngle, short arcAngle );

    Parameters

    r

    The rectangle that defines an oval’s boundaries.

    startAngle

    The angle indicating the start of the arc.

    arcAngle

    The angle indicating the arc’s extent.

    Discussion

    Using the patCopy pattern mode, the EraseArc function draws a wedge of the oval bounded by the rectangle that you specify in the r parameter with the background pattern for the current graphics port. As in FrameArc , use the startAngle and arcAngle parameters to define the arc of the wedge.

    This function leaves the location of the graphics pen unchanged.

    Special Considerations

    The EraseArc function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillArc FillArc Available in OS X v10.0 through OS X v10.6

    Fills a wedge with any available bit pattern.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillArc ( const Rect *r, short startAngle, short arcAngle, const Pattern *pat );

    Parameters

    r

    The rectangle that defines an oval’s boundaries.

    startAngle

    The angle indicating the start of the arc.

    arcAngle

    The bit pattern to use for the fill.

    pat

    The angle indicating the arc’s extent.

    Discussion

    Using the patCopy pattern mode and the pattern defined in the Pattern structure that you specify in the pat parameter, the FillArc function draws a wedge of the oval bounded by the rectangle that you specify in the r parameter. As in FrameArc use the startAngle and arcAngle parameters to define the arc of the wedge.

    This function leaves the location of the graphics pen unchanged.

    Use GetPattern and GetIndPattern to get a pattern stored in a resource.

    Use PaintArc to draw a wedge with the pen pattern for the current graphics port.

    To fill a wedge with a pixel pattern, use the FillCArc function.

    Special Considerations

    The FillArc function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FrameArc FrameArc Available in OS X v10.0 through OS X v10.6

    Draws an arc of the oval that fits inside a rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FrameArc ( const Rect *r, short startAngle, short arcAngle );

    Parameters

    r

    The rectangle that defines an oval’s boundaries.

    startAngle

    The angle indicating the start of the arc.

    arcAngle

    The angle indicating the arc’s extent.

    Discussion

    Using the pattern, pattern mode, and size of the graphics pen for the current graphics port, the FrameArc function draws an arc of the oval bounded by the rectangle that you specify in the r parameter. Use the startAngle parameter to specify where the arc begins as modulo 360. Use the arcAngle parameter to specify how many degrees the arc covers. Specify whether the angles are in positive or negative degrees a positive angle goes clockwise, while a negative angle goes counterclockwise. Zero degrees is at 12 o’clock high, 90 (or –270) is at 3 o’clock, 180 (or –180) is at 6 o’clock, and 270 (or –90) is at 9 o’clock. Measure other angles relative to the bounding rectangle.

    A line from the center of the rectangle through its upper-right corner is at 45, even if the rectangle is not square a line through the lower-right corner is at 135, and so on.

    The arc is as wide as the pen width and as tall as the pen height. The pen location does not change.

    Special Considerations

    The FrameArc function differs from other QuickDraw functions that frame shapes in that the arc is not mathematically added to the boundary of a region that’s open and being formed.

    The FrameArc function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • InvertArc InvertArc Available in OS X v10.0 through OS X v10.6

    Inverts the pixels of a wedge.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void InvertArc ( const Rect *r, short startAngle, short arcAngle );

    Parameters

    r

    The rectangle that defines an oval’s boundaries.

    startAngle

    The angle indicating the start of the arc.

    arcAngle

    The angle indicating the arc’s extent.

    Discussion

    The InvertArc function inverts the pixels enclosed by a wedge of the oval bounded by the rectangle that you specify in the r parameter. Every white pixel becomes black and every black pixel becomes white. As in FrameArc , use the startAngle and arcAngle parameters to define the arc of the wedge.

    This function leaves the location of the graphics pen unchanged.

    Special Considerations

    The InvertArc function was designed for 1-bit images in basic graphics ports. This function operates on color pixels in color graphics ports, but the results are predictable only with direct devices or 1-bit pixel maps. For indexed pixels, Color QuickDraw performs the inversion on the pixel indexes, which means the results depend entirely on the contents of the CLUT. The eight colors used in basic QuickDraw are stored in a color table represented by the global variable QDColors. To display those eight basic QuickDraw colors on an indexed device, Color QuickDraw uses the Color Manager to obtain indexes to the colors in the CLUT that best map to the colors in the QDColors color table. Because the index, not the color value, is inverted, the results are unpredictable.

    Inversion works better for direct pixels. Inverting a pure green, for example, that has red, green, and blue component values of $0000, $FFFF, and $0000 results in magenta, which has component values of $FFFF, $0000, and $FFFF.

    The InvertArc function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PaintArc PaintArc Available in OS X v10.0 through OS X v10.6

    Paints a wedge of the oval that fits inside a rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void PaintArc ( const Rect *r, short startAngle, short arcAngle );

    Parameters

    r

    The rectangle that defines an oval’s boundaries.

    startAngle

    The angle indicating the start of the arc.

    arcAngle

    The angle indicating the arc’s extent.

    Discussion

    Using the pen pattern and pattern mode of the current graphics port, the PaintArc function draws a wedge of the oval bounded by the rectangle that you specify in the r parameter. As in the FrameArc function, use the startAngle and arcAngle parameters to define the arc of the wedge.

    The pen location does not change.

    Use FillArc , to draw a wedge with a pattern different from that specified in the pnPat field of the current graphics port.

    Special Considerations

    The PaintArc function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Line Line Available in OS X v10.0 through OS X v10.6

    Draws a line a specified distance from the graphics pen’s current location in the current graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void Line ( short dh, short dv );

    Parameters

    dh

    The horizontal distance of the graphics pen’s movement.

    dv

    The vertical distance of the graphics pen’s movement.

    Discussion

    Starting at the current location of the graphics pen, the Line function draws a line the horizontal distance that you specify in the dh parameter and the vertical distance that you specify in the dv parameter. The Line function calls

    LineTo(h+dh,v+dv)

    where (h,v) is the current location in local coordinates. The pen location becomes the coordinates of the end of the line after the line is drawn. If you are using Line to draw a region or polygon, its outline is infinitely thin and is not affected by the values of the pnSize, pnMode, and pnPat fields of the graphics port.

    Special Considerations

    The Line function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • LineTo LineTo Available in OS X v10.0 through OS X v10.6

    Draws a line from the graphics pen’s current location to a new location.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void LineTo ( short h, short v );

    Parameters

    h

    The horizontal coordinate of the graphics pen’s new location.

    v

    The vertical coordinate of the graphics pen’s new location.

    Discussion

    The LineTo function draws a line from the graphics pen’s current location in the current graphics port to the new location (h,v), which you specify in the local coordinates of the current graphics port. If you are using LineTo to draw a region or polygon, its outline is infinitely thin and is not affected by the values of the pnSize, pnMode, or pnPat field of the graphics port.

    Special Considerations

    The LineTo function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Move Move Available in OS X v10.0 through OS X v10.6

    Moves the graphics pen a particular distance.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void Move ( short dh, short dv );

    Parameters

    dh

    The horizontal distance of the graphics pen’s movement.

    dv

    The vertical distance of the graphics pen’s movement.

    Discussion

    The Move function moves the graphics pen from its current location in the current graphics port a horizontal distance that you specify in the dh parameter and a vertical distance that you specify in the dv parameter. The Move function calls

    MoveTo(h+dh,v+dv)

    where (h,v) is the graphics pen’s current location in local coordinates. The Move function performs no drawing.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • MoveTo MoveTo Available in OS X v10.0 through OS X v10.6

    Moves the graphics pen to a particular location in the current graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void MoveTo ( short h, short v );

    Parameters

    h

    The horizontal coordinate of the graphics pen’s new position.

    v

    The vertical coordinate of the graphics pen’s new position.

    Discussion

    The MoveTo function changes the graphics pen’s current location to the new horizontal coordinate you specify in the h parameter and the new vertical coordinate you specify in the v parameter. Specify the new location in the local coordinates of the current graphics port. The MoveTo function performs no drawing.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • EraseOval EraseOval Available in OS X v10.0 through OS X v10.6

    Erases an oval.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void EraseOval ( const Rect *r );

    Parameters

    r

    The rectangle that defines the oval’s boundary.

    Discussion

    Using the background pattern for the current graphics port and the patCopy pattern mode, the EraseOval function draws the interior of an oval just inside the bounding rectangle that you specify in the r parameter. This effectively erases the oval bounded by the specified rectangle.

    This function leaves the location of the graphics pen unchanged.

    Special Considerations

    The EraseOval function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillOval FillOval Available in OS X v10.0 through OS X v10.6

    Fills an oval with any available bit pattern.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillOval ( const Rect *r, const Pattern *pat );

    Parameters

    r

    The rectangle that defines the oval’s boundaries.

    pat

    The bit pattern to use for the fill.

    Discussion

    Using the patCopy pattern mode and the bit pattern defined in the Pattern structure that you specify in the pat parameter, the FillOval function draws the interior of an oval just inside the bounding rectangle that you specify in the r parameter. The pen location does not change.

    Use GetPattern and GetIndPattern , to get a pattern stored in a resource. Use the PaintOval function to draw the interior of an oval with the pen pattern for the current graphics port.

    To fill an oval with a pixel pattern, use the FillCOval function.

    Special Considerations

    The FillOval function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FrameOval FrameOval Available in OS X v10.0 through OS X v10.6

    Draws an outline inside an oval.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FrameOval ( const Rect *r );

    Parameters

    r

    The rectangle that defines the oval’s boundary.

    Discussion

    Using the pattern, pattern mode, and size of the graphics pen for the current graphics port, the FrameOval function draws an outline just inside the oval with the bounding rectangle that you specify in the r parameter. The outline is as wide as the pen width and as tall as the pen height. The pen location does not change.

    If a region is open and being formed, the outside outline of the new oval is mathematically added to the region’s boundary.

    Special Considerations

    The FrameOval function may move or purge memory blocks in the application; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • InvertOval InvertOval Available in OS X v10.0 through OS X v10.6

    Inverts the pixels enclosed by an oval.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void InvertOval ( const Rect *r );

    Parameters

    r

    The rectangle that defines the oval’s boundary.

    Discussion

    The InvertOval function inverts the pixels enclosed by an oval just inside the bounding rectangle that you specify in the r parameter. Every white pixel becomes black and every black pixel becomes white. The pen location does not change.

    Special Considerations

    The InvertOval function was designed for 1-bit images in basic graphics ports. This function operates on color pixels in color graphics ports, but the results are predictable only with direct devices or 1-bit pixel maps. For indexed pixels, Color QuickDraw performs the inversion on the pixel indexes, which means the results depend entirely on the contents of the CLUT. The eight colors used in basic QuickDraw are stored in a color table represented by the global variable QDColors. To display those eight basic QuickDraw colors on an indexed device, Color QuickDraw uses the Color Manager to obtain indexes to the colors in the CLUT that best map to the colors in the QDColors color table. Because the index, not the color value, is inverted, the results are unpredictable.

    Inversion works better for direct pixels. Inverting a pure green, for example, that has red, green, and blue component values of $0000, $FFFF, and $0000 results in magenta, which has component values of $FFFF, $0000, and $FFFF.

    The InvertOval function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PaintOval PaintOval Available in OS X v10.0 through OS X v10.6

    Paints an oval with the graphics pen’s pattern and pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void PaintOval ( const Rect *r );

    Parameters

    r

    The rectangle that defines the oval’s boundary.

    Discussion

    Using the pen pattern and pattern mode for the current graphics port, the PaintOval function draws the interior of an oval just inside the bounding rectangle that you specify in the r parameter. The pen location does not change.

    Use FillOval to draw the interior of an oval with a pen pattern different from that for the current graphics port.

    Special Considerations

    The PaintOval function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • DrawPicture DrawPicture Available in OS X v10.0 through OS X v10.6

    Draws a picture on any type of output device.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void DrawPicture ( PicHandle myPicture, const Rect *dstRect );

    Parameters

    myPicture

    A handle to the picture to be drawn. You must access a picture through its handle.

    When creating pictures, the OpenCPicture and OpenPicture functions return their handles. You can use the GetPicture function to get a handle to a QuickDraw picture stored in a 'PICT' resource. To get a handle to a QuickDraw picture stored in a 'PICT' file, you must use File Manager functions. To get a picture stored in the scrap, use the Scrap Manager function GetScrap to get a handle to its data and then coerce this handle to one of type PicHandle.

    dstRect

    A destination rectangle, specified in coordinates local to the current graphics port, in which to draw the picture. The DrawPicture function shrinks or expands the picture as necessary to align the borders of its bounding rectangle with the rectangle you specify in this parameter. To display a picture at a resolution other than that at which it was created, your application should compute an appropriate destination rectangle by scaling its width and height by the following factor:

    scale factor = destination resolution / source resolution

    For example, if a picture was created at 300 dpi and you want to display it at 75 dpi, then your application should compute the destination rectangle width and height as 1/4 of those of the picture’s bounding rectangle. Use the GetPictInfo function to gather information about a picture. The PictInfo structure returned by GetPictInfo returns the picture’s resolution in its hRes and vRes fields. The sourceRect field contains the bounding rectangle for displaying the image at its optimal resolution.

    Discussion

    Within the rectangle that you specify in the dstRect parameter, the DrawPicture function draws the picture that you specify in the myPicture parameter.

    The DrawPicture function passes any picture comments to the StdComment function pointed to by the commentProc field of the CQDProcs or QDProcs structure, which in turn is pointed to by the grafProcs field of a CGrafPort or GrafPort structure. The default StdComment function provided by QuickDraw does no comment processing whatsoever. If you want to process picture comments when drawing a picture, use the SetStdCProcs function to assist you in changing the CQDProcs structure and use the SetStdProcs function to assist you in changing the QDProcs structure.

    Special Considerations

    Always use the ClipRect function to specify a clipping region appropriate for your picture before defining it with the OpenCPicture (or OpenPicture) function. If you do not use ClipRect to specify a clipping region, OpenCPicture uses the clipping region specified in the current graphics port. If the clipping region is very large (as it is when a graphics port is initialized) and you want to scale the picture, the clipping region can become invalid when DrawPicture scales the clipping region—in which case, your picture will not be drawn. On the other hand, if the graphics port specifies a small clipping region, part of your drawing may be clipped when DrawPicture draws it. Setting a clipping region equal to the port rectangle of the current graphics port always sets a valid clipping region.

    When it scales, DrawPicture changes the size of the font instead of scaling the bits. However, the widths used by bitmap fonts are not always linear. For example, the 12-point width isn’t exactly 1/2 of the 24-point width. This can cause lines of text to become slightly longer or shorter as the picture is scaled. The difference is often insignificant, but if you are trying to draw a line of text that fits exactly into a box (a spreadsheet cell, for example), the difference can become noticeable to the user—most typically, at print time. The easiest way to avoid such problems is to specify a destination rectangle that is the same size as the bounding rectangle for the picture. Otherwise, your application may need to directly process the opcodes in the picture instead of using DrawPicture.

    You may also have disappointing results if the fonts contained in an image are not available on the user’s system. Before displaying a picture, your application may want to use the Picture Utilities to determine what fonts are contained in the picture, and then use Font Manager functions to determine whether the fonts are available on the user’s system. If they are not, you can use Dialog Manager functions to display an alert box warning the user of display problems.

    If there is insufficient memory to draw a picture in Color QuickDraw, the QDError function returns the result code noMemForPictPlaybackErr.

    The DrawPicture function may move or purge memory.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetPicture GetPicture Available in OS X v10.0 through OS X v10.6

    Obtains a handle to a picture stored in a 'PICT' resource.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    PicHandle GetPicture ( short pictureID );

    Parameters

    pictureID

    The resource ID for a 'PICT' resource.

    Return Value

    A handle to the picture in the specified ‘PICT’ resource. To draw the picture stored in the resource, pass this handle to the DrawPicture function. If the resource cannot be read, GetPicture returns NULL.

    Discussion

    The GetPicture function calls the Resource Manager function GetResource as follows:

    GetResource(‘PICT’, picID)

    Special Considerations

    To release the memory occupied by a picture stored in a 'PICT' resource, use the Resource Manager function ReleaseResource.

    The GetPicture function may move or purge memory.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • ErasePoly ErasePoly Available in OS X v10.0 through OS X v10.6

    Erases a polygon.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void ErasePoly ( PolyHandle poly );

    Parameters

    poly

    A handle to the polygon to erase. The OpenPoly function returns this handle when you first create the polygon.

    Discussion

    Using the patCopy pattern mode, the ErasePoly function draws the interior of the polygon whose handle you pass in the poly parameter with the background pattern for the current graphics port.

    This function leaves the location of the graphics pen unchanged.

    This function temporarily converts the polygon into a region to perform their operations. The amount of memory required for this temporary region may be far greater than the amount required by the polygon alone.

    You can estimate the size of this region by scaling down the polygon with the MapPoly , converting the polygon into a region, checking the region’s size with the Memory Manager function GetHandleSize, and multiplying that value by the factor by which you scaled the polygon.

    The result of this graphics operation is undefined whenever any horizontal or vertical line drawn through the polygon would intersect the polygon’s outline more than 50 times.

    Special Considerations

    The ErasePoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillPoly FillPoly Available in OS X v10.0 through OS X v10.6

    Fills a polygon with any available bit pattern.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillPoly ( PolyHandle poly, const Pattern *pat );

    Parameters

    poly

    A handle to the polygon to fill. The OpenPoly function returns this handle when you first create the polygon.

    pat

    The bit pattern to use for the fill.

    Discussion

    Using the patCopy pattern mode, the FillPoly function draws the interior of the polygon whose handle you pass in the poly parameter with the pattern defined in the Pattern structure that you specify in the pat parameter.

    This function leaves the location of the graphics pen unchanged.

    This function temporarily converts the polygon into a region to perform their operations. The amount of memory required for this temporary region may be far greater than the amount required by the polygon alone.

    You can estimate the size of this region by scaling down the polygon with the MapPoly , converting the polygon into a region, checking the region’s size with the Memory Manager function GetHandleSize, and multiplying that value by the factor by which you scaled the polygon.

    The result of this graphics operation is undefined whenever any horizontal or vertical line drawn through the polygon would intersect the polygon’s outline more than 50 times.

    Use GetPattern and GetIndPattern to get a pattern stored in a resource.

    Use PaintPoly to draw the interior of a polygon with the pen pattern for the current graphics port. To fill a polygon with a pixel pattern, use the FillCPoly function.

    Special Considerations

    The FillPoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FramePoly FramePoly Available in OS X v10.0 through OS X v10.6

    Draws the outline of a polygon.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FramePoly ( PolyHandle poly );

    Parameters

    poly

    A handle to the polygon to draw. The OpenPoly function returns this handle when you first create the polygon.

    Discussion

    Using the current graphics port’s pen pattern, pattern mode, and size, the FramePoly function plays back the line-drawing commands that define the polygon whose handle you pass in the poly parameter.

    The graphics pen hangs below and to the right of each point on the boundary of the polygon. Thus, the drawn polygon extends beyond the right and bottom edges of the polygon’s bounding rectangle (which is stored in the polyBBox field of the Polygon structure) by the pen width and pen height, respectively. All other graphics operations, such as painting a polygon with the PaintPoly function, occur strictly within the boundary of the polygon.

    If a polygon is open and being formed, FramePoly affects the outline of the polygon just as if the line-drawing functions themselves had been called. If a region is open and being formed, the outside outline of the polygon being framed is mathematically added to the region’s boundary.

    The result of this function is undefined whenever any horizontal or vertical line through the polygon would intersect the polygon’s outline more than 50 times.

    Special Considerations

    The FramePoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • InvertPoly InvertPoly Available in OS X v10.0 through OS X v10.6

    Inverts the pixels enclosed by a polygon.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void InvertPoly ( PolyHandle poly );

    Parameters

    poly

    A handle to a polygon, the pixels of which you want to invert. The OpenPoly function returns this handle when you first create the polygon.

    Discussion

    The InvertPoly function inverts the pixels enclosed by the polygon whose handle you pass in the poly parameter. Every white pixel becomes black and every black pixel becomes white.

    This function leaves the location of the graphics pen unchanged.

    InvertPoly temporarily converts the polygon into a region to perform their operations. The amount of memory required for this temporary region may be far greater than the amount required by the polygon alone.

    You can estimate the size of this region by scaling down the polygon with the MapPoly , converting the polygon into a region, checking the region’s size with the Memory Manager function GetHandleSize, and multiplying that value by the factor by which you scaled the polygon.

    The result of this graphics operation is undefined whenever any horizontal or vertical line drawn through the polygon would intersect the polygon’s outline more than 50 times.

    Special Considerations

    The InvertPoly function was designed for 1-bit images in basic graphics ports. This function operates on color pixels in color graphics ports, but the results are predictable only with 1-bit or direct pixels. For indexed pixels, Color QuickDraw performs the inversion on the pixel indexes, which means the results depend entirely on the contents of the CLUT. The eight colors used in basic QuickDraw are stored in a color table represented by the global variable QDColors. To display those eight basic QuickDraw colors on an indexed device, Color QuickDraw uses the Color Manager to obtain indexes to the colors in the CLUT that best map to the colors in the QDColors color table. Because the index, not the color value, is inverted, the results are unpredictable.

    Inversion works better for direct pixels. Inverting a pure green, for example, that has red, green, and blue component values of $0000, $FFFF, and $0000 results in magenta, which has component values of $FFFF, $0000, and $FFFF.

    The InvertPoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PaintPoly PaintPoly Available in OS X v10.0 through OS X v10.6

    Paints a polygon with the graphics pen’s pattern and pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void PaintPoly ( PolyHandle poly );

    Parameters

    poly

    A handle to the polygon to paint. The OpenPoly function returns this handle when you first create the polygon.

    Discussion

    Using the pen pattern and pattern mode for the current graphics port, the PaintPoly function draws the interior of a polygon whose handle you pass in the poly parameter. The pen location does not change.

    This function temporarily converts the polygon into a region to perform their operations. The amount of memory required for this temporary region may be far greater than the amount required by the polygon alone.

    You can estimate the size of this region by scaling down the polygon with the MapPoly , converting the polygon into a region, checking the region’s size with the Memory Manager function GetHandleSize, and multiplying that value by the factor by which you scaled the polygon.

    The result of this graphics operation is undefined whenever any horizontal or vertical line drawn through the polygon would intersect the polygon’s outline more than 50 times.

    Use the FillPoly function to draw the interior of a polygon with a pattern different from that specified in the pnPat field of the current graphics port.

    Special Considerations

    Do not create a height or width for the polygon greater than 32,767 pixels, or PaintPoly will crash.

    The PaintPoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • EraseRect EraseRect Available in OS X v10.0 through OS X v10.6

    Erases a rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void EraseRect ( const Rect *r );

    Parameters

    r

    The rectangle to erase.

    Discussion

    Using the patCopy pattern mode, the EraseRect function draws the interior of the rectangle that you specify in the r parameter with the background pattern for the current graphics port. This effectively erases the rectangle, making the shape blend into the background pattern of the graphics port. For example, use EraseRect to erase the port rectangle for a window before redrawing into the window.

    This function leaves the location of the graphics pen unchanged.

    Special Considerations

    The EraseRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillRect FillRect Available in OS X v10.0 through OS X v10.6

    Fills a rectangle with any available bit pattern.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillRect ( const Rect *r, const Pattern *pat );

    Parameters

    r

    The rectangle to fill.

    pat

    The bit pattern to use for the fill.

    Discussion

    Using the patCopy pattern mode, the FillRect function draws the interior of the rectangle that you specify in the r parameter with the pattern defined in the Pattern structure that you specify in the pat parameter. This function leaves the pen location unchanged.

    Use GetPattern and GetIndPattern , to get a pattern stored in a resource.

    Use the PaintRect to draw the interior of a rectangle with the pen pattern for the current graphics port. To fill a rectangle with a pixel pattern, use the FillCRect function.

    Special Considerations

    The FillRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FrameRect FrameRect Available in OS X v10.0 through OS X v10.6

    Draws an outline inside a rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FrameRect ( const Rect *r );

    Parameters

    r

    The rectangle to frame.

    Discussion

    Using the pattern, pattern mode, and size of the graphics pen for the current graphics port, the FrameRect function draws an outline just inside the rectangle that you specify in the r parameter. The outline is as wide as the pen width and as tall as the pen height. The pen location does not change.

    If a region is open and being formed, the outside outline of the new rectangle is mathematically added to the region’s boundary.

    Special Considerations

    The FrameRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • InvertRect InvertRect Available in OS X v10.0 through OS X v10.6

    Inverts the pixels enclosed by a rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void InvertRect ( const Rect *r );

    Parameters

    r

    The rectangle whose enclosed pixels are to be inverted.

    Discussion

    The InvertRect function inverts the pixels enclosed by the rectangle that you specify in the r parameter. Every white pixel becomes black and every black pixel becomes white. The pen location does not change.

    Special Considerations

    The InvertRect function was designed for 1-bit images in basic graphics ports. This function operates on color pixels in color graphics ports, but the results are predictable only with direct pixels or 1-bit pixel maps. For indexed pixels, Color QuickDraw performs the inversion on the pixel indexes, which means the results depend entirely on the contents of the CLUT. The eight colors used in basic QuickDraw are stored in a color table represented by the global variable QDColors. To display those eight basic QuickDraw colors on an indexed device, Color QuickDraw uses the Color Manager to obtain indexes to the colors in the CLUT that best map to the colors in the QDColors color table. Because the index, not the color value, is inverted, the results are unpredictable.

    Inversion works better for direct pixels. Inverting a pure green, for example, that has red, green, and blue component values of $0000, $FFFF, and $0000 results in magenta, which has component values of $FFFF, $0000, and $FFFF.

    The InvertRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PaintRect PaintRect Available in OS X v10.0 through OS X v10.6

    Paints a rectangle with the graphics pen’s pattern and pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void PaintRect ( const Rect *r );

    Parameters

    r

    The rectangle to paint.

    Discussion

    The PaintRect function draws the interior of the rectangle that you specify in the r parameter with the pen pattern for the current graphics port, according to the pattern mode for the current graphics port. The pen location does not change.

    Use the FillRect to draw the interior of a rectangle with a pen pattern different from that for the current graphics port.

    Special Considerations

    The PaintRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • EraseRgn EraseRgn Available in OS X v10.0 through OS X v10.6

    Erases a region.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void EraseRgn ( RgnHandle rgn );

    Parameters

    rgn

    The region to erase.

    Discussion

    Using the patCopy pattern mode, the EraseRgn function draws the interior of the region whose handle you pass in the rgn parameter with the background pattern for the current graphics port.

    This function leaves the location of the graphics pen unchanged.

    This function depends on the local coordinate system of the current graphics port. If you draw a region in a graphics port different from the one in which you defined the region, it may not appear in the proper position in the graphics port.

    If any horizontal or vertical line drawn through the region would intersect the region’s outline more than 50 times, the results of this graphics operation are undefined.

    Special Considerations

    The EraseRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillRgn FillRgn Available in OS X v10.0 through OS X v10.6

    Fills a region with any available bit pattern.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillRgn ( RgnHandle rgn, const Pattern *pat );

    Parameters

    rgn

    A handle to the region to fill.

    pat

    The bit pattern to use for the fill.

    Discussion

    Using the patCopy pattern mode, the FillRgn function draws the interior of the region with the pattern defined in the Pattern structure that you specify in the pat parameter.

    This function leaves the location of the graphics pen unchanged.

    This function depends on the local coordinate system of the current graphics port. If you draw a region in a graphics port different from the one in which you defined the region, it may not appear in the proper position in the graphics port.

    If any horizontal or vertical line drawn through the region would intersect the region’s outline more than 50 times, the results of this graphics operation are undefined.

    Use GetPattern and GetIndPattern to get a pattern stored in a resource.

    Use PaintRgn to draw the interior of a region with the pen pattern for the current graphics port. To fill a region with a pixel pattern, use the FillCRegion function.

    Special Considerations

    The FillRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FrameRgn FrameRgn Available in OS X v10.0 through OS X v10.6

    Draws an outline inside a region.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FrameRgn ( RgnHandle rgn );

    Parameters

    rgn

    A handle to the region to frame.

    Discussion

    Using the current graphics port’s pen pattern, pattern mode, and pen size, the FrameRgn function 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.

    This function depends on the local coordinate system of the current graphics port. If you draw a region in a graphics port different from the one in which you defined the region, it may not appear in the proper position in the graphics port.

    If any horizontal or vertical line drawn through the region would intersect the region’s outline more than 50 times, the results of this graphics operation are undefined. The FrameRgn function in particular requires that there would be no more than 25 such intersections.

    Special Considerations

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

    The FrameRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • InvertRgn InvertRgn Available in OS X v10.0 through OS X v10.6

    Inverts the pixels enclosed by a region.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void InvertRgn ( RgnHandle rgn );

    Parameters

    rgn

    A handle to the region whose pixels are to invert.

    Discussion

    The InvertRgn function inverts the pixels enclosed by the region whose handle you pass in the rgn parameter. Every white pixel becomes black and every black pixel becomes white.

    This function leaves the location of the graphics pen unchanged.

    This function depends on the local coordinate system of the current graphics port. If you draw a region in a graphics port different from the one in which you defined the region, it may not appear in the proper position in the graphics port.

    If any horizontal or vertical line drawn through the region would intersect the region’s outline more than 50 times, the results of this graphics operation are undefined.

    Special Considerations

    The InvertRgn function was designed for 1-bit images in basic graphics ports. This function operates on color pixels in color graphics ports, but the results are predictable only with 1-bit or direct pixels. For indexed pixels, Color QuickDraw performs the inversion on the pixel indexes, which means the results depend entirely on the contents of the CLUT. The eight colors used in basic QuickDraw are stored in a color table represented by the global variable QDColors. To display those eight basic QuickDraw colors on an indexed device, Color QuickDraw uses the Color Manager to obtain indexes to the colors in the CLUT that best map to the colors in the QDColors color table. Because the index, not the color value, is inverted, the results are unpredictable.

    Inversion works better for direct pixels. Inverting a pure green, for example, that has red, green, and blue component values of $0000, $FFFF, and $0000 results in magenta, which has component values of $FFFF, $0000, and $FFFF.

    The InvertRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PaintRgn PaintRgn Available in OS X v10.0 through OS X v10.6

    Paints a region with the graphics pen’s pattern and pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void PaintRgn ( RgnHandle rgn );

    Parameters

    rgn

    A handle to the region to paint.

    Discussion

    Using the pen pattern and pattern mode for the current graphics port, the PaintRgn function draws the interior of the region whose handle you pass in the rgn parameter. The pen location does not change.

    This function depends on the local coordinate system of the current graphics port. If you draw a region in a graphics port different from the one in which you defined the region, it may not appear in the proper position in the graphics port.

    If any horizontal or vertical line drawn through the region would intersect the region’s outline more than 50 times, the results of this graphics operation are undefined.

    Use FillRgn to draw the interior of a region with a pen pattern different from that for the current graphics port.

    Special Considerations

    The PaintRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • EraseRoundRect EraseRoundRect Available in OS X v10.0 through OS X v10.6

    Erases a rounded rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void EraseRoundRect ( const Rect *r, short ovalWidth, short ovalHeight );

    Parameters

    r

    The rectangle that defines the rounded rectangle’s boundaries.

    ovalWidth

    The width of the oval defining the rounded corner.

    ovalHeight

    The height of the oval defining the rounded corner.

    Discussion

    Using the patCopy pattern mode, the EraseRoundRect function draws the interior of the rounded rectangle bounded by the rectangle that you specify in the r parameter with the background pattern of the current graphics port. This effectively erases the rounded rectangle. Use the ovalWidth and ovalHeight parameters to specify the diameters of curvature for the corners of the rounded rectangle.

    This function leaves the location of the graphics pen unchanged.

    Special Considerations

    The EraseRoundRect function may move or purge memory blocks in the application; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillRoundRect FillRoundRect Available in OS X v10.0 through OS X v10.6

    Fills a rounded rectangle with any available bit pattern.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillRoundRect ( const Rect *r, short ovalWidth, short ovalHeight, const Pattern *pat );

    Parameters

    r

    The rectangle that defines the rounded rectangle’s boundaries.

    ovalWidth

    The width of the oval defining the rounded corner.

    ovalHeight

    The height of the oval defining the rounded corner.

    pat

    The bit pattern to use for the fill.

    Discussion

    Using the patCopy pattern mode, the FillRoundRect function draws the interior of the rounded rectangle bounded by the rectangle that you specify in the r parameter with the bit pattern defined in the Pattern structure that you specify in the pat parameter. Use the ovalWidth and ovalHeight parameters to specify the diameters of curvature for the corners. The pen location does not change.

    To fill a rounded rectangle with a pixel pattern, use the FillCRoundRect function.

    Use GetPattern and GetIndPattern to get a pattern stored in a resource. Use PaintRoundRect to draw the interior of a rounded rectangle with the pen pattern for the current graphics port.

    Special Considerations

    The FillRoundRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FrameRoundRect FrameRoundRect Available in OS X v10.0 through OS X v10.6

    Draws an outline inside a rounded rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FrameRoundRect ( const Rect *r, short ovalWidth, short ovalHeight );

    Parameters

    r

    The rectangle that defines the rounded rectangle’s boundaries.

    ovalWidth

    The width of the oval defining the rounded corner.

    ovalHeight

    The height of the oval defining the rounded corner.

    Discussion

    Using the pattern, pattern mode, and size of the graphics pen for the current graphics port, the FrameRoundRect function draws an outline just inside the rounded rectangle bounded by the rectangle that you specify in the r parameter. The outline is as wide as the pen width and as tall as the pen height. The pen location does not change.

    Use the ovalWidth and ovalHeight parameters to specify the diameters of curvature for the corners of the rounded rectangle.

    If a region is open and being formed, the outside outline of the new rounded rectangle is mathematically added to the region’s boundary.

    Special Considerations

    The FrameRoundRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • InvertRoundRect InvertRoundRect Available in OS X v10.0 through OS X v10.6

    Inverts the pixels enclosed by a rounded rectangle.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void InvertRoundRect ( const Rect *r, short ovalWidth, short ovalHeight );

    Parameters

    r

    The rectangle that defines the rounded rectangle’s boundaries.

    ovalWidth

    The width of the oval defining the rounded corner.

    ovalHeight

    The height of the oval defining the rounded corner.

    Discussion

    The InvertRoundRect function inverts the pixels enclosed by the rounded rectangle bounded by the rectangle that you specify in the r parameter. Every white pixel becomes black and every black pixel becomes white. The ovalWidth and ovalHeight parameters specify the diameters of curvature for the corners. The pen location does not change.

    Special Considerations

    The InvertRoundRect function was designed for 1-bit images in basic graphics ports. This function operates on color pixels in color graphics ports, but the results are predictable only with direct devices or 1-bit pixel maps. For indexed pixels, Color QuickDraw performs the inversion on the pixel indexes, which means the results depend entirely on the contents of the CLUT. The eight colors used in basic QuickDraw are stored in a color table represented by the global variable QDColors. To display those eight basic QuickDraw colors on an indexed device, Color QuickDraw uses the Color Manager to obtain indexes to the colors in the CLUT that best map to the colors in the QDColors color table. Because the index, not the color value, is inverted, the results are unpredictable.

    Inversion works better for direct pixels. Inverting a pure green, for example, that has red, green, and blue component values of $0000, $FFFF, and $0000 results in magenta, which has component values of $FFFF, $0000, and $FFFF.

    The InvertRoundRect function may move or purge memory blocks in the application; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • PaintRoundRect PaintRoundRect Available in OS X v10.0 through OS X v10.6

    Paints a rounded rectangle with the graphics pen’s pattern and pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void PaintRoundRect ( const Rect *r, short ovalWidth, short ovalHeight );

    Parameters

    r

    The rectangle that defines the rounded rectangle’s boundaries.

    ovalWidth

    The width of the oval defining the rounded corner.

    ovalHeight

    The height of the oval defining the rounded corner.

    Discussion

    Using the pattern and pattern mode of the graphics pen for the current graphics port, the PaintRoundRect function draws the interior of the rounded rectangle bounded by the rectangle that you specify in the r parameter. Use the ovalWidth and ovalHeight parameters to specify the diameters of curvature for the corners of the rounded rectangle.

    The pen location does not change.

    Use FillRoundRect to draw the interior of a rounded rectangle with a pen pattern different from that for the current graphics port.

    Special Considerations

    The PaintRoundRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillCArc FillCArc Available in OS X v10.0 through OS X v10.6

    Fills a wedge with the given pixel pattern, using the patCopy pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillCArc ( const Rect *r, short startAngle, short arcAngle, PixPatHandle pp );

    Parameters

    r

    The rectangle that defines the oval’s boundaries.

    startAngle

    The angle indicating the start of the arc.

    arcAngle

    The angle indicating the arc’s extent.

    pp

    A handle to the PixPat structure for the pixel pattern to be used for the fill.

    Discussion

    Use the startAngle and arcAngle parameters to define the arc of the wedge. This function ignores the pnPat, pnMode, and bkPat fields of the current graphics port and leaves the pen location unchanged.

    Special Considerations

    The FillCArc function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillCOval FillCOval Available in OS X v10.0 through OS X v10.6

    Fills an oval with the given pixel pattern, using the patCopy pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillCOval ( const Rect *r, PixPatHandle pp );

    Parameters

    r

    The rectangle containing the oval to be filled.

    pp

    A handle to the PixPat structure for the pixel pattern to be used for the fill.

    Discussion

    This function ignores the pnPat, pnMode, and bkPat fields of the current graphics port and leaves the pen location unchanged.

    Special Considerations

    The FillCOval function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillCPoly FillCPoly Available in OS X v10.0 through OS X v10.6

    Fills a polygon with the given pixel pattern, using the patCopy pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillCPoly ( PolyHandle poly, PixPatHandle pp );

    Parameters

    poly

    A handle to the polygon to be filled.

    pp

    A handle to the PixPat structure for the pixel pattern to be used for the fill.

    Discussion

    This function ignores the pnPat, pnMode, and bkPat fields of the current graphics port and leaves the pen location unchanged.

    Special Considerations

    The FillCPoly function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillCRect FillCRect Available in OS X v10.0 through OS X v10.6

    Fills a rectangle with the given pixel pattern, using the patCopy pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillCRect ( const Rect *r, PixPatHandle pp );

    Parameters

    r

    The rectangle to be filled.

    pp

    A handle to the PixPat structure for the pixel pattern to be used for the fill.

    Discussion

    This function ignores the pnPat, pnMode, and bkPat fields of the current graphics port and leaves the pen location unchanged.

    Special Considerations

    The FillCRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillCRgn FillCRgn Available in OS X v10.0 through OS X v10.6

    Fills a region with the given pixel pattern, using the patCopy pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillCRgn ( RgnHandle rgn, PixPatHandle pp );

    Parameters

    rgn

    A handle to the region to be filled.

    pp

    A handle to the PixPat structure for the pixel pattern to be used for the fill.

    Discussion

    This function ignores the pnPat, pnMode, and bkPat fields of the current graphics port and leaves the pen location unchanged.

    Special Considerations

    The FillCRgn function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • FillCRoundRect FillCRoundRect Available in OS X v10.0 through OS X v10.6

    Fills a rounded rectangle with the given pixel pattern, using the patCopy pattern mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void FillCRoundRect ( const Rect *r, short ovalWidth, short ovalHeight, PixPatHandle pp );

    Parameters

    r

    The rectangle that defines the rounded rectangle’s boundaries.

    ovalWidth

    The width of the oval defining the rounded corner.

    ovalHeight

    The height of the oval defining the rounded corner.

    pp

    A handle to the PixPat structure for the pixel pattern to be used for the fill.

    Discussion

    Use the ovalWidth and ovalHeight parameters to specify the diameters of curvature for the corners. This function ignores the pnPat, pnMode, and bkPat fields of the current graphics port and leaves the pen location unchanged.

    Special Considerations

    The FillCRoundRect function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • HiliteColor HiliteColor Available in OS X v10.0 through OS X v10.6

    Changes the highlight color for the current color graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void HiliteColor ( const RGBColor *color );

    Parameters

    color

    An RGBColor structure that defines the highlight color.

    Discussion

    All drawing operations that use the hilite transfer mode use the highlight color. When a color graphics port is created, its highlight color is initialized from the global variable HiliteRGB.

    If the current graphics port is a basic graphics port, HiliteColor has no effect.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • OpColor OpColor Available in OS X v10.0 through OS X v10.6

    Sets the maximum color values for the addPin and subPin arithmetic transfer modes and the weight color for the blend arithmetic transfer mode.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void OpColor ( const RGBColor *color );

    Parameters

    color

    An RGBColor structure that defines a color.

    Discussion

    Specify the red, green, and blue values in the RGBColor structure and specify this structure in the color parameter.

    If the current graphics port is defined by a GrafPort structure, OpColor has no effect.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • RGBBackColor RGBBackColor Available in OS X v10.0 through OS X v10.6

    Changes the background color.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void RGBBackColor ( const RGBColor *color );

    Parameters

    color

    An RGBColor structure.

    Discussion

    If the current port is defined by a CGrafPort structure, QuickDraw supplies its rgbBkColor field with the RGB value that you specify in the color parameter, and places the pixel value most closely matching that color in the bkColor field. For indexed devices, the pixel value is an index to the current device’s CLUT. F or direct devices, the value is the 16-bit or 32-bit equivalent to the RGB value.

    If the current port is defined by a GrafPort structure, basic QuickDraw supplies its fgColor field with a color value determined by taking the high bit of each of the red, green, and blue components of the color that you supply in the color parameter. Basic QuickDraw uses that 3-bit number to select a color from its eight-color system.

    You can also use Palette Manager functions to set the background color.

    To determine the current background color, use the GetBackColor function.

    Because a pixel pattern already contains color, QuickDraw ignores the background color and foreground colors when your application draws with a pixel pattern. Use the PenPixPat function to assign a pixel pattern to the foreground pattern used by the graphics pen. Use the BackPixPat function to assign a pixel pattern as the background pattern for the current color graphics port. Use the FillCRect, FillCOval, FillCRoundRect, FillCArc, FillCRgn, and FillCPoly functions to fill shapes with a pixel pattern.

    Special Considerations

    The RGBBackColor function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • RGBForeColor RGBForeColor Available in OS X v10.0 through OS X v10.6

    Changes the color of the “ink” used for framing and painting.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void RGBForeColor ( const RGBColor *color );

    Parameters

    color

    An RGBColor structure.

    Discussion

    If the current port is defined by a CGrafPort structure, QuickDraw supplies its rgbFgColor field with the RGB value that you specify in the color parameter, and places the pixel value most closely matching that color in the fgColor field. For indexed devices, the pixel value is an index to the current device’s CLUT. For direct devices, the value is the 16-bit or 32-bit equivalent to the RGB value.

    If the current port is defined by a GrafPort structure, basic QuickDraw supplies its fgColor field with a color value determined by taking the high bit of each of the red, green, and blue components of the color that you supply in the color parameter. Basic QuickDraw uses that 3-bit number to select a color from its eight-color system.

    You can also use Palette Manager functions to set the foreground color.

    To determine the current foreground color, use the GetForeColor function.

    QuickDraw ignores the foreground and background colors when your application draws with a pixel pattern. Assign a pixel pattern to the foreground pattern used by the graphics pen; by using the BackPixPat function to assign a pixel pattern as the background pattern for the current color graphics port; and by using the FillCRect, FillCOval, FillCRoundRect, FillCArc, FillCRgn, and FillCPoly functions to fill shapes with a pixel pattern.

    Special Considerations

    The RGBForeColor function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • SetCPixel SetCPixel Available in OS X v10.0 through OS X v10.6

    Sets the color of an individual pixel to the color that most closely matches the RGB color that you specify in the cPix parameter.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void SetCPixel ( short h, short v, const RGBColor *cPix );

    Parameters

    h

    The horizontal coordinate of the point at the upper-left corner of the pixel.

    v

    The vertical coordinate of the point at the upper-left corner of the pixel.

    cPix

    An RGBColor structure.

    Discussion

    On an indexed color system, the SetCPixel function sets the pixel value to the index of the best-matching color in the current device’s CLUT. In a direct environment, the SetCPixel function sets the pixel value to a 16-bit or 32-bit direct pixel value.

    To determine the color of an individual pixel, use the GetCPixel function.

    Special Considerations

    The SetCPixel function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • BackColor BackColor Available in OS X v10.0 through OS X v10.6

    Changes a basic graphics port’s background color.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void BackColor ( long color );

    Parameters

    color

    One of eight color values. See Color Constants.

    Discussion

    The background color is the color of the pixels in the bitmap wherever no drawing has taken place. By default the background color of a GrafPort is white.

    The BackColor function sets the background color for the current graphics port to the color that you specify in the color parameter. When you draw with the patCopy and srcCopy transfer modes, for example, white pixels are drawn in the color you specify with BackColor.

    All nonwhite colors appear as black on black-and-white screens. Before you use BackColor, use the DeviceLoop function to determine the color characteristics of the current screen.

    Special Considerations

    The BackColor function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • ColorBit ColorBit Available in OS X v10.0 through OS X v10.6

    Sets the foreground color for all printing in the current graphics port.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void ColorBit ( short whichBit );

    Parameters

    whichBit

    An integer specifying the plane to draw into.

    Discussion

    The ColorBit function is called by printing software for a color printer (or other color-imaging software) to set the GrafPort structure’s colorBit field to the value in the whichBit parameter. This value tells QuickDraw which plane of the color picture to draw into. QuickDraw draws into the plane corresponding to the bit number specified by the whichBit parameter. Since QuickDraw can support output devices that have up to 32 bits of color information per pixel, the possible range of values for whichBit is 0 through 31. The initial value of the colorBit field is 0.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • ForeColor ForeColor Available in OS X v10.0 through OS X v10.6

    Changes the color of the “ink” used for framing, painting, and filling on computers that support only basic QuickDraw.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void ForeColor ( long color );

    Parameters

    color

    One of eight color values. See Color Constants.

    Discussion

    By default, the foreground color of a GrafPort is black.

    The ForeColor function sets the foreground color for the current graphics port to the color that you specify in the color parameter. When you draw with the patCopy and srcCopy transfer modes, for example, black pixels are drawn in the color you specify with ForeColor.

    When printing, use the ColorBit function to set the foreground color.

    All nonwhite colors appear as black on black-and-white screens. Before you use ForeColor, use the DeviceLoop function to determine the color characteristics of the current screen.

    Special Considerations

    The ForeColor function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetIndPattern GetIndPattern Available in OS X v10.0 through OS X v10.6

    Obtains a pattern stored in a pattern list ('PAT#') resource.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    void GetIndPattern ( Pattern *thePat, short patternListID, short index );

    Parameters

    thePat

    On return, a pointer to a Pattern structure for the pattern stored in the specified pattern list resource.

    patternListID

    The resource ID for a resource of type 'PAT#'.

    index

    The index number for the desired pattern within the pattern list ('PAT#') resource. The index number can range from 1 to the number of patterns in the pattern list resource.

    Discussion

    The GetIndPattern function calls the following Resource Manager function with these parameters:

    • GetResource('PAT#', patternListID);

    There is a pattern list resource in the System file that contains the standard Macintosh patterns used by MacPaint. The resource ID is represented by the constant sysPatListID.

    Special Considerations

    The GetIndPattern function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetPattern GetPattern Available in OS X v10.0 through OS X v10.6

    Obtains a pattern ('PAT') resource stored in a resource file.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    PatHandle GetPattern ( short patternID );

    Parameters

    patternID

    The resource ID for a resource of type ‘PAT’.

    Return Value

    a handle to the pattern having the resource ID that you specify in the patID parameter. If a pattern resource with the ID that you request does not exist, the GetPattern function returns NULL.

    Discussion

    The GetPattern function calls the following Resource Manager function with these parameters:

    GetResource('PAT', patID);

    When you are finished using the pattern, dispose of its handle with the Memory Manager function DisposeHandle.

    Special Considerations

    The GetPattern function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetDeviceList GetDeviceList Available in OS X v10.0 through OS X v10.6

    Obtains a handle to the first GDevice structure in the device list.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    GDHandle GetDeviceList ( void );

    Return Value

    A handle to the first GDevice structure in the global variable DeviceList.

    Discussion

    All existing GDevice structures are linked together in the device list. After using this function to obtain a handle to the current GDevice structure, your application can use the GetNextDevice function to obtain a handle to the next GDevice structure in the list.

    Special Considerations

    The GetDeviceList function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetGDevice GetGDevice Available in OS X v10.0 through OS X v10.6

    Obtains a handle to the GDevice structure for the current device.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    GDHandle GetGDevice ( void );

    Return Value

    A handle to the current device.

    Discussion

    At any given time, exactly one video device is the current device—that is, the one on which drawing is actually taking place.

    Color QuickDraw stores a handle to the current device in the global variable TheGDevice.

    All existing GDevice structures are linked together in the device list. After using this function to obtain a handle to the current GDevice structure, your application can use the GetNextDevice function to obtain a handle to the next GDevice structure in the list.

    You can also use the GetGWorld function to get a handle to the GDevice structure for the current device.

    Special Considerations

    The GetGDevice function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetMainDevice GetMainDevice Available in OS X v10.0 through OS X v10.6

    Obtains a handle to the GDevice structure for the main screen.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    GDHandle GetMainDevice ( void );

    Return Value

    A handle to the device for the main screen, which is the device containing the menu bar.

    Discussion

    A handle to the main device is kept in the global variable MainDevice.

    All existing GDevice structures are linked together in the device list. After using this function to obtain a handle to the current GDevice structure, your application can use the GetNextDevice function to obtain a handle to the next GDevice structure in the list.

    Special Considerations

    The GetMainDevice function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetMaxDevice GetMaxDevice Available in OS X v10.0 through OS X v10.6

    Obtains a handle to the GDevice structure for the video device with the greatest pixel depth.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    GDHandle GetMaxDevice ( const Rect *globalRect );

    Parameters

    globalRect

    A rectangle, in global coordinates, that intersects the graphics devices that you are searching to find the one with the greatest pixel depth.

    Return Value

    A handle to the device with the greatest pixel depth.

    Discussion

    All existing GDevice structures are linked together in the device list. After using this function to obtain a handle to the current GDevice structure, your application can use the GetNextDevice function to obtain a handle to the next GDevice structure in the list.

    Special Considerations

    The GetMaxDevice function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • GetNextDevice GetNextDevice Available in OS X v10.0 through OS X v10.6

    Returns a handle to the next GDevice structure in the device list.

    Deprecation Statement

    Use Quartz 2D instead; see Quartz Programming Guide for QuickDraw Developers.

    Declaration

    Objective-C

    GDHandle GetNextDevice ( GDHandle curDevice );

    Parameters

    curDevice

    A handle to the GDevice structure at which you want the search to begin.

    Return Value

    A handle to the next device. If there are no more GDevice structures in the list, NULL.

    Discussion

    After using any of the functions GetDeviceList , GetGDevice , GetMainDevice , or GetMaxDevice to obtain a handle to a GDevice structure, use the GetNextDevice function to obtain a handle to the next GDevice structure in the list.

    Special Considerations

    The GetNextDevice function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • InitCursor InitCursor Available in OS X v10.0 through OS X v10.6

    Sets the cursor to the standard arrow and makes the cursor visible.

    Declaration

    Objective-C

    void InitCursor ( void );

    Discussion

    This function initializes the standard arrow cursor, sets the current cursor to the standard arrow, and makes the cursor visible. Classic Mac OS applications need to call this function when launching because the system sets the cursor to the watch cursor. Carbon applications running in Mac OS 9 or Mac OS X do not need to call this function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • HideCursor HideCursor Available in OS X v10.0 through OS X v10.6

    Hides the cursor if it is visible on the screen.

    Declaration

    Objective-C

    void HideCursor ( void );

    Discussion

    The HideCursor function removes the cursor from the screen, restores the bits under the cursor image, and decrements the cursor level (which InitCursor initialized to 0). You might want to use HideCursor when the user is using the keyboard to create content in one of your application’s windows. Every call to HideCursor should be balanced by a subsequent call to the ShowCursor function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • ObscureCursor ObscureCursor Available in OS X v10.0 through OS X v10.6

    Hides the cursor until the next time the user moves the mouse.

    Declaration

    Objective-C

    void ObscureCursor ( void );

    Discussion

    Your application normally calls ObscureCursor when the user begins to type. Unlike HideCursor , ObscureCursor has no effect on the cursor level and must not be balanced by a call to ShowCursor.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • ShieldCursor ShieldCursor Available in OS X v10.0 through OS X v10.6

    Hides the cursor in a rectangle.

    Declaration

    Objective-C

    void ShieldCursor ( const Rect *shieldRect, Point offsetPt );

    Parameters

    shieldRect

    A rectangle in which the cursor is hidden whenever the cursor intersects the rectangle. The rectangle may be specified in global or local coordinates. If you are using global coordinates, pass (0,0) in the offsetPt parameter. If you are using the local coordinates of a graphics port, pass the coordinates for the upper-left corner of the graphics port’s boundary rectangle in the offsetPt parameter.

    offsetPt

    A point value for the offset of the rectangle. Like the basic QuickDraw function LocalToGlobal, the ShieldCursor function offsets the coordinates of the rectangle by the coordinates of this point.

    Discussion

    If the cursor and the given rectangle intersect, ShieldCursor hides the cursor. If they do not intersect, the cursor remains visible while the mouse is not moving, but is hidden when the mouse moves. Use this function with a feature such as QuickTime to display content in a specified rectangle. When a QuickTime movie is animating, the cursor should not be visible in front of the movie.

    The ShieldCursor function decrements the cursor level and should be balanced by a call to the ShowCursor function.

    Availability

    Available in OS X v10.0 through OS X v10.6.

    Not available to 64-bit applications.

  • ShowCursor ShowCursor Available in OS X v10.0 through OS X v10.6

    Displays a cursor hidden by the HideCursor or ShieldCursor functions.

    Declaration

    Objective-C

    void ShowCursor ( void );

    Discussion

    ShowCursor increments the cursor level, which has been decremented by the HideCursor or ShieldCursor function and displays the cursor on the screen when the level is 0. A call to the ShowCursor function balances each previous call to the HideCursor or ShieldCursor function. The level is not incremented beyond 0, so extra calls to ShowCursor have no effect.

    Low-level interrupt-driven functions link the cursor with the mouse position, so that if the cursor level is 0 and visible, the cursor automatically follows the mouse.

    If the cursor has been changed with the SetCursor function while hidden, ShowCursor displays the new cursor.

    Availability

    Available