XMVector3LinePointDistance method

Computes the minimum distance between a line and a point.

Syntax


XMVECTOR XMVector3LinePointDistance(
  [in] XMVECTOR LinePoint1,
  [in] XMVECTOR LinePoint2,
  [in] XMVECTOR Point
);

Parameters

LinePoint1 [in]: 3D vector describing a point on the line.
LinePoint2 [in]: 3D vector describing a point on the line.
Point [in]: 3D vector describing the reference point.

Return value

Returns a vector. The minimum distance between the line and the point is replicated to each of the components.

Remarks

Platform Requirements

Microsoft Visual Studio 2010 or Microsoft Visual Studio 2012 with the Windows SDK for Windows 8. Supported for Win32 desktop apps, Windows Store apps, and Windows Phone 8 apps.

Requirements

Namespace	Use DirectX.
Header	DirectXMath.h