Edit

ID2D1DeviceContext::DrawImage(ID2D1Effect*,constD2D1_POINT_2F*,constD2D1_RECT_F*,D2D1_INTERPOLATION_MODE,D2D1_COMPOSITE_MODE) method (d2d1_1.h)

  • Article

Draws an image to the device context.

Syntax

void DrawImage(
  [in]           ID2D1Effect             *effect,
  [in, optional] const D2D1_POINT_2F     *targetOffset,
  [in, optional] const D2D1_RECT_F       *imageRectangle,
                 D2D1_INTERPOLATION_MODE interpolationMode,
                 D2D1_COMPOSITE_MODE     compositeMode
);

Parameters

[in] effect

Type: ID2D1Effect*

The effect to be drawn to the device context.

[in, optional] targetOffset

Type: const D2D1_POINT_2F*

The offset in the destination space that the image will be rendered to. The entire logical extent of the image will be rendered to the corresponding destination. If not specified, the destination origin will be (0, 0). The top-left corner of the image will be mapped to the target offset. This will not necessarily be the origin. This default value is NULL.

[in, optional] imageRectangle

Type: const D2D1_RECT_F*

The corresponding rectangle in the image space will be mapped to the given origins when processing the image. This default value is NULL.

interpolationMode

Type: D2D1_INTERPOLATION_MODE

The interpolation mode that will be used to scale the image if necessary.

compositeMode

Type: D2D1_COMPOSITE_MODE

The composite mode that will be applied to the limits of the currently selected clip. The default value is D2D1_COMPOSITE_MODE_SOURCE_OVER

Return value

None

Remarks

If interpolationMode is D2D1_INTERPOLATION_MODE_HIGH_QUALITY, different scalers will be used depending on the scale factor implied by the world transform.

Any invalid rectangles accumulated on any effect that is drawn by this call will be discarded regardless of which portion of the image rectangle is drawn.

If compositeMode is D2D1_COMPOSITE_MODE_SOURCE_OVER, DrawImage will use the currently selected primitive blend specified by ID2D1DeviceContext::SetPrimitiveBlend. If compositeMode is not D2D1_COMPOSITE_MODE_SOURCE_OVER, the image will be extended to transparent up to the current axis-aligned clip.

If there is an image rectangle and a world transform, this is equivalent to inserting a clip effect to represent the image rectangle and a 2D affine transform to take into account the world transform.

Requirements

Requirement Value
Minimum supported client Windows 8 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header d2d1_1.h
DLL D2d1.dll

See also

ID2D1Bitmap

ID2D1Bitmap1

ID2D1DeviceContext

ID2D1Effect

ID2D1Image