Windows Dev Center

ID2D1RenderTarget::DrawRectangle method

Draws the outline of a rectangle that has the specified dimensions and stroke style.

Syntax


virtual void DrawRectangle(
  [in]           const D2D1_RECT_F      *rect,
  [in]                 ID2D1Brush       *brush,
                       FLOAT            strokeWidth = 1.0f,
  [in, optional]       ID2D1StrokeStyle *strokeStyle = NULL
) = 0;

Parameters

rect [in]

Type: const D2D1_RECT_F*

The dimensions of the rectangle to draw, in device-independent pixels.

brush [in]

Type: ID2D1Brush*

The brush used to paint the rectangle's stroke.

strokeWidth

Type: FLOAT

The width of the stroke, in device-independent pixels. The value must be greater than or equal to 0.0f. If this parameter isn't specified, it defaults to 1.0f. The stroke is centered on the line.

strokeStyle [in, optional]

Type: ID2D1StrokeStyle*

The style of stroke to paint, or NULL to paint a solid stroke.

Return value

This method does not return a value.

Remarks

When this method fails, it does not return an error code. To determine whether a drawing method (such as DrawRectangle) failed, check the result returned by the ID2D1RenderTarget::EndDraw or ID2D1RenderTarget::Flush method.

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
Creating a Simple Direct2D Application
How to Draw and Fill a Basic Shape

 

 

Community Additions

ADD
Show:
© 2015 Microsoft