Windows apps
Collapse the table of content
Expand the table of content
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.

IWICPlanarFormatConverter::Initialize method

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

ppPlanes [in]

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

Minimum supported client

Windows 8.1 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 R2 [desktop apps | Windows Store apps]

Header

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

See also

IWICPlanarFormatConverter
IWICFormatConverter::Initialize

 

 

Show:
© 2017 Microsoft