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.

ID2D1DeviceContext::CreateBitmapFromWicBitmap method

Creates a Direct2D bitmap by copying a WIC bitmap.

Syntax

C++


HRESULT CreateBitmapFromWicBitmap(
  [in]                 IWICBitmapSource        *wicBitmapSource,
  [in, optional] const D2D1_BITMAP_PROPERTIES1 *bitmapProperties,
  [out]                ID2D1Bitmap1            **bitmap
);

Parameters

wicBitmapSource [in]

Type: IWICBitmapSource*

The WIC bitmap source to copy from.

bitmapProperties [in, optional]

Type: const D2D1_BITMAP_PROPERTIES1*

A bitmap properties structure that specifies bitmap creation options.

bitmap [out]

Type: ID2D1Bitmap1**

The address of the newly created bitmap object.

Return value

Type: HRESULT

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

HRESULT	Description
S_OK	No error occurred.
E_OUTOFMEMORY	Direct2D could not allocate sufficient memory to complete the call.
E_INVALIDARG	An invalid parameter was passed to the returning function.

Remarks

Starting with Windows 8.1, the bitmapProperties parameter is optional. When it is not specified, the created bitmap inherits the pixel format and alpha mode from wicBitmapSource. For a list of supported pixel formats and alpha modes, see Supported Pixel Formats and Alpha Modes.

When the bitmapProperties parameter is specified, the value in bitmapProperties->pixelFormat must either be DXGI_FORMAT_UNKNOWN or must match the WIC pixel format in wicBitmapSource.

When bitmapProperties->pixelFormat.alphaMode is set to D2D1_ALPHA_MODE_UNKNOWN, the newly created bitmap inherits the alpha mode from wicBitmapSource. When bitmapProperties->pixelFormat.alphaMode is set to D2D1_ALPHA_MODE_PREMULTIPLIED, D2D1_ALPHA_MODE_STRAIGHT, or D2D1_ALPHA_MODE_IGNORE, this forces the newly created bitmap to use the specified alpha mode.

Requirements

Minimum supported client	Windows 8 and Platform Update for Windows 7 [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| Windows Store apps]
Minimum supported phone	Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]
Header	D2d1_1.h
DLL	D2d1.dll