IWICBitmapEncoder::SetPalette method

Sets the global palette for the image.

Syntax


HRESULT SetPalette(
  [in] IWICPalette *pIPalette
);

Parameters

pIPalette [in]

Type: IWICPalette*

The IWICPalette to use as the global palette.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise.

Returns WINCODEC_ERR_UNSUPPORTEDOPERATION if the feature is not supported by the encoder.

Remarks

Only GIF images support an optional global palette, and you must set the global palette before adding any frames to the image. You only need to set the palette for indexed pixel formats.

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

 

 

Show: