wglGetLayerPaletteEntries

The wglGetLayerPaletteEntries function retrieves the palette entries from a given color-index layer plane for a specified device context.

int wglGetLayerPaletteEntries(
  HDC  hdc,          // device context of a window whose layer 
                     // planes are to be described
  int  iLayerPlane,  // specifies an overlay or underlay plane
  int  iStart,       // specifies the first palette entry to be set
  int  cEntries,     // specifies the number of palette entries to 
                     // be set
  CONST COLORREF *pcr 
                     // points to the first member of an array of 
                     // COLORREF structures
);
 

Parameters

hdc

Specifies the device context of a window whose layer planes are to be described.

iLayerPlane

Specifies the overlay or underlay plane. Positive values of iLayerPlane identify overlay planes, where 1 is the first overlay plane over the main plane, 2 is the second overlay plane over the first overlay plane, and so on. Negative values identify underlay planes, where –1 is the first underlay plane under the main plane, –2 is the second underlay plane under the first underlay plane, and so on. The number of overlay and underlay planes is given in the bReserved member of the PIXELFORMATDESCRIPTOR structure.

iStart

Specifies the first palette entry to be retrieved.

cEntries

Specifies the number of palette entries to be retrieved.

pcr

Points to an array of COLORREF structures that contain palette RGB color values. The array must contain at least as many structures as specified by cEntries.

Return Values

If the function succeeds, the return value is the number of entries that were set in the palette in the specified layer plane of the window.

If the function fails or when no pixel format is selected, the return value is zero. To get extended error information, call GetLastError.

Remarks

Each color-index layer plane in a window has a palette with a size 2^n, where n is the number of bit planes in the layer plane. You cannot modify the transparent index of a palette.

Use the wglRealizeLayerPalette function to realize the layer palette. Initially the layer palette contains only entries for white.

The wglSetPaletteEntries function doesn't set the palette entries of the main plane palette. To update the main plane palette, use GDI palette functions.

QuickInfo

  Windows NT: Use version 3.5 and later.
  Windows: Use Windows 95 and later.
  Windows CE: Unsupported.
  Header: Declared in wingdi.h.
  Import Library: Link with opengl32.lib.

See Also

OpenGL on Windows NT and Windows 95 Overview, WGL Functions, COLORREF, LAYERPLANEDESCRIPTOR, PIXELFORMATDESCRIPTOR, wglDescribeLayerPlane, wglRealizeLayerPalette, wglSetLayerPaletteEntries