Edit

Share via

BitmapProperties1 function (d2d1_1helper.h)

  • Article

Creates a D2D1_BITMAP_PROPERTIES1 structure.

Syntax

D2D1_BITMAP_PROPERTIES1 BitmapProperties1(
       D2D1_BITMAP_OPTIONS     bitmapOptions,
  [in] const D2D1_PIXEL_FORMAT pixelFormat,
       FLOAT                   dpiX,
       FLOAT                   dpiY,
  [in] ID2D1ColorContext       *colorContext
);

Parameters

bitmapOptions

Type: D2D1_BITMAP_OPTIONS

A combination of D2D1_BITMAP_OPTIONS-typed values that specify how the bitmap can be used.

[in] pixelFormat

Type: const D2D1_PIXEL_FORMAT

The bitmap's pixel format and alpha mode. The default value is a D2D1_PIXEL_FORMAT with a format of DXGI_FORMAT_UNKNOWN and an alphaMode of D2D1_ALPHA_MODE_UNKNOWN. For more information about pixel formats, see Supported Pixel Formats and Alpha Modes.

dpiX

Type: FLOAT

The horizontal dpi of the bitmap. The default value is 96.0f.

dpiY

Type: FLOAT

The vertical dpi of the bitmap. The default value is 96.0f.

[in] colorContext

Type: ID2D1ColorContext*

An optional pointer to the ID2D1ColorContext interface for a color context to use with the bitmap. If you don't want to specify a color context, set this parameter to NULL.

Return value

Type: D2D1_BITMAP_PROPERTIES1

A D2D1_BITMAP_PROPERTIES1 structure that describes the bitmap.

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_1helper.h
Library D2d1.lib
DLL D2d1.dll