XMVector3LinePointDistance function (directxmath.h)

Article
02/22/2024

Computes the minimum distance between a line and a point.

Syntax

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

Parameters

[in] LinePoint1

3D vector describing a point on the line.

[in] LinePoint2

3D vector describing a point on the line.

[in] Point

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

Requirement	Value
Target Platform	Windows
Header	directxmath.h (include DirectXMath.h)