IWICBitmapSource::GetPixelFormat method (wincodec.h)

Retrieves the pixel format of the bitmap source..

Syntax

HRESULT GetPixelFormat(
  [out] WICPixelFormatGUID *pPixelFormat
);

Parameters

[out] pPixelFormat

Type: WICPixelFormatGUID*

Receives the pixel format GUID the bitmap is stored in. For a list of available pixel formats, see the Native Pixel Formats topic.

Return value

Type: HRESULT

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

Remarks

The pixel format returned by this method is not necessarily the pixel format the image is stored as. The codec may perform a format conversion from the storage pixel format to an output pixel format.

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