wglSetLayerPaletteEntries  3JIW_VW 

[New - Windows 95, OEM Service Release 2]

The wglSetLayerPaletteEntries function sets the palette entries in a given color-index layer plane for a specified device context.

int wglSetLayerPaletteEntries(

Parameters

hdc

Specifies the device context of a window whose layer palette is to be set.

iLayerPlane

Specifies an 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 PIXELFORMATDESCRIPTOR99A54N structure.

iStart

Specifies the first palette entry to be set.

cEntries

Specifies the number of palette entries to be set.

pcr

Points to the first member of an array of cEntries COLORREF5ZHB8H structures that contain RGB color information.

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 no pixel format is selected, the return value is zero. To get extended error information, call GetLastError11C2VS7.

Remarks

Each color-index 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 wglSetLayerPaletteEntries function doesn t set the palette entries of the main plane palette. To update the main plane palette, use GDI palette functions.

See Also