Export (0) Print
Expand All

ID2D1RenderTarget::CreateBitmapFromWicBitmap method

Creates an ID2D1Bitmap by copying the specified Microsoft Windows Imaging Component (WIC) bitmap.

Syntax


HRESULT CreateBitmapFromWicBitmap(
  [in]   IWICBitmapSource *wicBitmapSource,
  const D2D1_BITMAP_PROPERTIES &bitmapProperties,
  [out]  ID2D1Bitmap **bitmap
);

Parameters

wicBitmapSource [in]

Type: IWICBitmapSource*

The WIC bitmap to copy.

bitmapProperties [ref]

Type: const D2D1_BITMAP_PROPERTIES

The pixel format and DPI of the bitmap to create. The pixel format must match the pixel format of wicBitmapSource, or the method will fail. To prevent a mismatch, you can pass NULL or pass the value obtained from calling the D2D1::PixelFormat helper function without specifying any parameter values. If both dpiX and dpiY are 0.0f, the default DPI, 96, is used. DPI information embedded in wicBitmapSource is ignored.

bitmap [out]

Type: ID2D1Bitmap**

When this method returns, contains a pointer to a pointer to the new bitmap. This parameter is passed uninitialized.

Return value

Type: HRESULT

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

Remarks

Before Direct2D can load a WIC bitmap, that bitmap must be converted to a supported pixel format and alpha mode. For a list of supported pixel formats and alpha modes, see Supported Pixel Formats and Alpha Modes.

Examples

For examples, see How to Load a Bitmap from a File and How to Load a Bitmap from a Resource.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

D2d1.h

Library

D2d1.lib

DLL

D2d1.dll

See also

ID2D1RenderTarget
ID2D1Bitmap
How to Load a Bitmap from a File
Supported Pixel Formats and Alpha Modes

 

 

Community Additions

ADD
Show:
© 2014 Microsoft