IWICBitmapLock::GetPixelFormat method

Gets the pixel format of for the locked area of pixels. This can be used to compute the number of bytes-per-pixel in the locked area.

Syntax


HRESULT GetPixelFormat(
  [out] WICPixelFormatGUID *pPixelFormat
);

Parameters

pPixelFormat [out]

Type: WICPixelFormatGUID*

A pointer that receives the pixel format GUID of the locked area.

Return value

Type: HRESULT

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

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: