Edit

IWICPlanarFormatConverter::Initialize method (wincodec.h)

  • Article

Initializes a format converter with a planar source, and specifies the interleaved output pixel format.

Syntax

HRESULT Initialize(
  [in] IWICBitmapSource      **ppPlanes,
       UINT                  cPlanes,
       REFWICPixelFormatGUID dstFormat,
       WICBitmapDitherType   dither,
       IWICPalette           *pIPalette,
       double                alphaThresholdPercent,
       WICBitmapPaletteType  paletteTranslate
);

Parameters

[in] ppPlanes

Type: IWICBitmapSource**

An array of IWICBitmapSource that represents image planes.

cPlanes

Type: UINT

The number of component planes specified by the planes parameter.

dstFormat

Type: REFWICPixelFormatGUID

The destination interleaved pixel format.

dither

Type: WICBitmapDitherType

The WICBitmapDitherType used for conversion.

pIPalette

Type: IWICPalette*

The palette to use for conversion.

alphaThresholdPercent

Type: double

The alpha threshold to use for conversion.

paletteTranslate

Type: WICBitmapPaletteType

The palette translation type to use for conversion.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 R2 [desktop apps | UWP apps]
Target Platform Windows
Header wincodec.h
Library Windowscodecs.lib
DLL Windowscodecs.dll

See also

IWICFormatConverter::Initialize

IWICPlanarFormatConverter