Inside Macintosh: Apple Game Sprockets Guide /

Chapter 2 - DrawSprocket / DrawSprocket Reference

DrawSprocket Functions / Drawing and Double Buffering

DSpContext_GetDirtyRectGridSize

You can use the DSpContext_GetDirtyRectGridSize function to find out the current grid cell size for a context's dirty rectangles.

OSStatus DSpContext_GetDirtyRectGridSize (
DSpContextReference inContext,
UInt32 *outCellPixelWidth,
UInt32 *outCellPixelHeight);

inContext

A reference to a context for which you want to know the current grid cell size of the dirty rectangles.

outCellPixelWidth

On exit, the width of the grid cell in pixels.

outCellPixelHeight

On exit, the height of the grid cell in pixels.

function result

A result code.

DESCRIPTION

The DSpContext_GetDirtyRectGridSize function takes, in the inContext parameter, a reference to a context and returns, in the outCellPixelWidth and outCellPixelHeight parameters, the current width and height of a dirty rectangle grid cell in pixels. The height and width values may be different from the values specified in DSpContext_SetDirtyRectGridSize because the grid cells must be multiples of the base grid cell. To find out the dimensions of the base grid cell, you can use the DSpContext_GetDirtyRectGridUnits function.

CALLING RESTRICTIONS

Do not call this function during an interrupt.