ID2D1RenderTarget::CreateBitmap method

Creates a Direct2D bitmap from a pointer to in-memory source data.

Syntax

virtual HRESULT CreateBitmap(
                       D2D1_SIZE_U            size,
  [in, optional]       void                   *srcData,
                       UINT32                 pitch,
  [in]           const D2D1_BITMAP_PROPERTIES *bitmapProperties,
  [out]                ID2D1Bitmap            **bitmap
) = 0;

Parameters

size

Type: D2D1_SIZE_U

The dimension of the bitmap to create in pixels.

srcData [in, optional]

Type: void*

A pointer to the memory location of the image data, or NULL to create an uninitialized bitmap.

pitch

Type: UINT32

The byte count of each scanline, which is equal to (the image width in pixels × the number of bytes per pixel) + memory padding. If srcData is NULL, this value is ignored. (Note that pitch is also sometimes called stride.)

bitmapProperties [in]

Type: const D2D1_BITMAP_PROPERTIES*

The pixel format and dots per inch (DPI) of the bitmap to create.

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.

Requirements

See also

ID2D1RenderTarget