XMVector3NearEqual function (directxmath.h)

12/05/2018
2 minutes to read

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

Syntax

bool XM_CALLCONV XMVector3NearEqual(
  FXMVECTOR V1,
  FXMVECTOR V2,
  FXMVECTOR Epsilon
);

Parameters

V1

3D vector.

V2

3D vector.

Epsilon

Tolerance value used for judging equality.

Return value

Returns true if V1 is near V2 and 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 ) && 
         ( abs( V1.z - V2.z ) <= 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


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