Inside Macintosh: Apple Game Sprockets Guide /

Chapter 2 - DrawSprocket / DrawSprocket Reference

DrawSprocket Functions / Manipulating Color Lookup Tables

DSpContext_GetCLUTEntries

You can use the DSpContext_GetCLUTEntries function to retrieve one or more color entries from a color lookup table.

OSStatus DSpContext_GetCLUTEntries (
		DSpContextReference inContext,
		ColorSpec *outEntries,
		UInt16 inStartingEntry,
		UInt16 inEntryCount);

inContext

The context whose color lookup table is to be accessed.

outEntries

On exit, an array of color specification records that contain the retrieved table entries.

inStartingEntry

The (zero-based) index position in the color lookup table of the first entry to retrieve.

inEntryCount

The number of entries to retrieve.

function result

A result code.

DESCRIPTION

The DSpContext_GetCLUTEntries function gets a range of entries from the color lookup table for the context specified in the inContext parameter. You pass in the number of entries to get in the inEntryCount parameter and the index position of the first entry in the inStartingEntry parameter. The function returns, in the outEntries parameter, an array of records containing the table entries it retrieved.

After you get the entries you can modify them and reassign them to the color table, for purposes such as color-table animation, with the DSpContext_SetCLUTEntries function (page 2-70).

CALLING RESTRICTIONS

Do not call this function during an interrupt.