XMVector3EqualR function (directxmath.h)

Article
02/22/2024

Tests whether two 3D vectors are equal. In addition, this function returns a comparison value that can be examined using functions such as XMComparisonAllTrue.

Syntax

uint32_t XM_CALLCONV XMVector3EqualR(
  [in] FXMVECTOR V1,
  [in] FXMVECTOR V2
) noexcept;

Parameters

[in] V1

3D vector.

[in] V2

3D vector.

Return value

Returns a comparison value that can be examined using functions such as XMComparisonAllTrue.

Remarks

This function does the following test:

V1.x == V2.x
V1.y == V2.y
V1.z == V2.z

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)

Share via