XMVector2NearEqual function (directxmath.h)

Article
02/22/2024

Tests whether one 2D vector is near another 2D vector.

Syntax

bool XM_CALLCONV XMVector2NearEqual(
  [in] FXMVECTOR V1,
  [in] FXMVECTOR V2,
  [in] FXMVECTOR Epsilon
) noexcept;

Parameters

[in] V1

2D vector.

[in] V2

2D vector.

[in] Epsilon

Tolerance value used for judging equality.

Return value

Returns true if the difference between components is less than Epsilon; returns false otherwise.

Remarks

The following pseudocode demonstrates the operation of the function:

return ( ( abs( V1.x - V2.x ) <= Epsilon ) && 
         ( abs( V1.y - V2.y ) <= Epsilon ) );

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)