ID2D1Geometry::StrokeContainsPoint method

Determines whether the geometry's stroke contains the specified point given the specified stroke thickness, style, and transform.

Syntax


HRESULT StrokeContainsPoint(
                       D2D1_POINT_2F     point,
                       FLOAT             strokeWidth,
  [in, optional]       ID2D1StrokeStyle  *strokeStyle,
  [in, optional] const D2D1_MATRIX_3X2_F *worldTransform,
  [out]                BOOL              *contains
) const;

Parameters

point

Type: D2D1_POINT_2F

The point to test for containment.

strokeWidth

Type: FLOAT

The thickness of the stroke to apply.

strokeStyle [in, optional]

Type: ID2D1StrokeStyle*

The style of stroke to apply.

worldTransform [in, optional]

Type: const D2D1_MATRIX_3X2_F*

The transform to apply to the stroked geometry.

contains [out]

Type: BOOL*

When this method returns, contains a boolean value set to true if the geometry's stroke contains the specified point; otherwise, false. You must allocate storage for this parameter.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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

ID2D1Geometry

 

 

Show: