ID2D1RenderTarget::CreateBitmapBrush(ID2D1Bitmap*,constD2D1_BITMAP_BRUSH_PROPERTIES&,ID2D1BitmapBrush**) method (d2d1.h)

Article
02/22/2024

Creates an ID2D1BitmapBrush from the specified bitmap. The brush uses the default values for its opacity and transform.

Syntax

HRESULT CreateBitmapBrush(
  [in]  ID2D1Bitmap                          *bitmap,
  [ref] const D2D1_BITMAP_BRUSH_PROPERTIES & bitmapBrushProperties,
  [out] ID2D1BitmapBrush                     **bitmapBrush
);

Parameters

[in] bitmap

Type: ID2D1Bitmap*

The bitmap contents of the new brush.

[ref] bitmapBrushProperties

Type: const D2D1_BITMAP_BRUSH_PROPERTIES

The extend modes and interpolation mode of the new brush.

[out] bitmapBrush

Type: ID2D1BitmapBrush**

When this method returns, contains a pointer to a pointer to the new brush. 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

The bitmap brush created by this method has an opacity of 1.0f and the identity matrix as its transform.

Examples

For an example showing how to paint an area with a bitmap brush, see How to Create a Bitmap Brush.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	d2d1.h
Library	D2d1.lib
DLL	D2d1.dll