AnimatePalette function (wingdi.h)

The AnimatePalette function replaces entries in the specified logical palette.

Syntax

BOOL AnimatePalette(
  [in] HPALETTE           hPal,
  [in] UINT               iStartIndex,
  [in] UINT               cEntries,
  [in] const PALETTEENTRY *ppe
);

Parameters

[in] hPal

A handle to the logical palette.

[in] iStartIndex

The first logical palette entry to be replaced.

[in] cEntries

The number of entries to be replaced.

[in] ppe

A pointer to the first member in an array of PALETTEENTRY structures used to replace the current entries.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

An application can determine whether a device supports palette operations by calling the GetDeviceCaps function and specifying the RASTERCAPS constant.

The AnimatePalette function only changes entries with the PC_RESERVED flag set in the corresponding palPalEntry member of the LOGPALETTE structure.

If the given palette is associated with the active window, the colors in the palette are replaced immediately.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header wingdi.h (include Windows.h)
Library Gdi32.lib
DLL Gdi32.dll

See also

Color Functions

Colors Overview

CreatePalette

GetDeviceCaps

LOGPALETTE

PALETTEENTRY