Legacy Document

Inside Macintosh: Advanced Color Imaging Reference /

Chapter 1 - Palette Manager Reference /

Palette Manager Functions / Drawing With Color Palettes

PmBackColor

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

pascal void PmBackColor(short dstEntry); 

dstEntry

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

DISCUSSION

The PmBackColor function sets the current color graphics port's rgbBkColor 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, PmBackColor calls the RGBBackColor function using the RGB color of the palette entry. For animated colors, PmBackColor selects the recorded device index previously reserved for animation (if still present) and installs it in the color graphics port. The rgbBgColor field is set to the value from the palette entry. For explicit colors, PmBackColor 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, maxIndex varies appropriately for each device.