Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

AnimatePalette function

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

hpal [in]

A handle to the logical palette.

iStartIndex [in]

The first logical palette entry to be replaced.

cEntries [in]

The number of entries to be replaced.

ppe [in]

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Colors Overview
Color Functions
CreatePalette
GetDeviceCaps
LOGPALETTE
PALETTEENTRY

 

 

Show: