IWICPalette::InitializeFromBitmap method (wincodec.h)

Article
02/22/2024

Initializes a palette using a computed optimized values based on the reference bitmap.

Syntax

HRESULT InitializeFromBitmap(
  [in] IWICBitmapSource *pISurface,
  [in] UINT             cCount,
  [in] BOOL             fAddTransparentColor
);

Parameters

[in] pISurface

Type: IWICBitmapSource*

Pointer to the source bitmap.

[in] cCount

Type: UINT

The number of colors to initialize the palette with.

[in] fAddTransparentColor

Type: BOOL

A value to indicate whether to add a transparent color.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The resulting palette contains the specified number of colors which best represent the colors present in the bitmap. The algorithm operates on the opaque RGB color value of each pixel in the reference bitmap and hence ignores any alpha values. If a transparent color is required, set the fAddTransparentColor parameter to TRUE and one fewer optimized color will be computed, reducing the colorCount, and a fully transparent color entry will be added.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	wincodec.h
Library	Windowscodecs.lib
DLL	Windowscodecs.dll

Share via