Edit

Share via

IWICImagingFactory::CreateBitmapFromSource method (wincodec.h)

  • Article

Creates a IWICBitmap from a IWICBitmapSource.

Syntax

HRESULT CreateBitmapFromSource(
  [in]  IWICBitmapSource           *pIBitmapSource,
  [in]  WICBitmapCreateCacheOption option,
  [out] IWICBitmap                 **ppIBitmap
);

Parameters

[in] pIBitmapSource

Type: IWICBitmapSource*

The IWICBitmapSource to create the bitmap from.

[in] option

Type: WICBitmapCreateCacheOption

The cache options of the new bitmap. This can be one of the values in the WICBitmapCreateCacheOption enumeration.

Value Meaning
WICBitmapNoCache
 Do not create a system memory copy. Share the bitmap with the source.
WICBitmapCacheOnDemand
 Create a system memory copy when the bitmap is first used.
WICBitmapCacheOnLoad
 Create a system memory copy when this method is called.

[out] ppIBitmap

Type: IWICBitmap**

A pointer that receives a pointer to the new bitmap.

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 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