ID2D1CommandSink::DrawRectangle method (d2d1_1.h)

Draws a rectangle.

Syntax

HRESULT DrawRectangle(
  [in]           const D2D1_RECT_F *rect,
  [in]           ID2D1Brush        *brush,
                 FLOAT             strokeWidth,
  [in, optional] ID2D1StrokeStyle  *strokeStyle
);

Parameters

[in] rect

Type: const D2D1_RECT_F*

The rectangle to be drawn to the command sink.

[in] brush

Type: ID2D1Brush*

The brush used to stroke the geometry.

strokeWidth

Type: FLOAT

The width of the stroke.

[in, optional] strokeStyle

Type: ID2D1StrokeStyle*

The style of the stroke.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

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

ID2D1CommandList::Stream

ID2D1CommandSink

ID2D1RenderTarget::DrawRectangle