IWICPlanarFormatConverter::CanConvert method (wincodec.h)

Query if the format converter can convert from one format to another.

Syntax

HRESULT CanConvert(
  [in]  const WICPixelFormatGUID *pSrcPixelFormats,
        UINT                     cSrcPlanes,
  [in]  REFWICPixelFormatGUID    dstPixelFormat,
  [out] BOOL                     *pfCanConvert
);

Parameters

[in] pSrcPixelFormats

An array of WIC pixel formats that represents source image planes.

cSrcPlanes

The number of source pixel formats specified by the pSrcFormats parameter.

[in] dstPixelFormat

The destination interleaved pixel format.

[out] pfCanConvert

True if the conversion is supported.

Return value

If the conversion is not supported, this method returns S_OK, but *pfCanConvert is set to FALSE.

If this method fails, the out parameter pfCanConvert is invalid.

Remarks

To specify an interleaved input pixel format, provide a length 1 array to pSrcPixelFormats.

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

IWICPlanarFormatConverter