Legacy Document

Inside Macintosh: Advanced Color Imaging Reference /

Chapter 1 - Palette Manager Reference /

Palette Manager Functions / Drawing With Color Palettes

PmForeColor

Sets the foreground color field of the current graphics port to a palette color.

pascal void PmForeColor(short dstEntry); 

dstEntry

The palette entry whose color is to be used as the foreground color.

DISCUSSION

The PmForeColor function sets the current color graphics port's rgbFgColor field to match the color in the entry specified by the dstEntry parameter of the palette associated with the current window structure. For courteous and tolerant entries, PmForeColor calls the RGBForeColor function using the RGB color of the palette entry. For animated colors, PmForeColor selects the recorded device index previously reserved for animation (if still present) and installs it in the color graphics port. The RGB foreground color field is set to the value from the palette entry. For explicit colors, PmForeColor places the value

dstEntry modulo (maxIndex +1)

into the color graphics port, where maxIndex is the largest index available in a device's color table. When multiple devices with different depths are present, the value of maxIndex varies appropriately for each device.

SEE ALSO

The color graphics port is described in the chapter "Color QuickDraw" in Inside Macintosh: Imaging With QuickDraw.