Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This macro accepts three values that represent the relative intensities of red, green, and blue and returns a palette-relative RGB specifier consisting of 2 in the high-order byte and an RGB value in the three low-order bytes (with a value representing the intensity of red, green, or blue in each of the bytes).

An application using a color palette can pass this specifier, instead of an explicit RGB value, to functions that expect a color.

Syntax

COLORREF PALETTERGB( 
  BYTE 
bRed, 
  BYTE 
bGreen, 
  BYTE 
bBlue
);

Parameters

bRed

Specifies the intensity of the red color field.

bGreen

Specifies the intensity of the green color field.

bBlue

Specifies the intensity of the blue color field.

Return Value

The return value is a palette-relative RGB specifier.

For output devices that support logical palettes, the system matches a palette-relative RGB value to the nearest color in the logical palette of the device context as though the application had specified an index to that palette entry.

If an output device does not support a system palette, the system uses the palette-relative RGB as though it were a conventional RGB DWORDreturned by the RGBmacro.

Remarks

The PALETTERGBmacro is defined as follows.

Copy Code
#define PALETTERGB(r, g, b)  (0x02000000 | RGB(r, g, b)) 

Requirements

Header windows.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

GDI Macros
RGB