Export (0) Print
Expand All

wglSetLayerPaletteEntries function

Applies to: desktop apps only

Sets the palette entries in a given color-index layer plane for a specified device context.

Syntax

int WINAPI wglSetLayerPaletteEntries(
  HDC hdc,
  int iLayerPlane,
  int iStart,
  int cEntries,
  const COLORREF *pcr
);

Parameters

hdc

Type: HDC

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

iLayerPlane

Type: int

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 PIXELFORMATDESCRIPTOR structure.

iStart

Type: int

The first palette entry to be set.

cEntries

Type: int

The number of palette entries to be set.

pcr

Type: const COLORREF*

A pointer to the first member of an array of cEntries structures that contain RGB color information.

Return value

Type: int

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 GetLastError.

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.

Requirements

Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server

Header

Wingdi.h

Library

Opengl32.lib

DLL

Opengl32.dll

See also

OpenGL on Windows
WGL Functions
LAYERPLANEDESCRIPTOR
PIXELFORMATDESCRIPTOR
wglDescribeLayerPlane
wglGetLayerPaletteEntries
wglRealizeLayerPalette

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft