PALETTEINDEX

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library

Header File
wingdi.h
Unicode
No
Platform Notes
None

The PALETTEINDEX macro accepts an index to a logical-color palette entry and returns a palette-entry specifier consisting of a 32-bit COLORREF value that specifies the color associated with the given index. An application using a logical color palette can pass this specifier, instead of an explicit red, green, blue (RGB) value, to GDI functions that expect a color. This allows the function to use the color in the specified palette entry.

COLORREF PALETTEINDEX(

WORD wPaletteIndex	// index to palette entry
);

Parameters
wPaletteIndex

Specifies an index to the palette entry containing the color to be used for a graphics operation.

Return Values
The return value is a logical-palette index specifier.

Remarks
The PALETTEINDEX macro is defined as follows:

#define PALETTEINDEX(i) /

((COLORREF) (0x01000000 | (DWORD) (WORD) (i)))