XMQuaternionEqual function (directxmath.h)

Article
02/22/2024

Tests whether two quaternions are equal.

Syntax

bool XM_CALLCONV XMQuaternionEqual(
  [in] FXMVECTOR Q1,
  [in] FXMVECTOR Q2
) noexcept;

Parameters

[in] Q1

First quaternion to test.

[in] Q2

Second quaternion to test.

Return value

Returns true if the quaternions are equal and false otherwise.

Remarks

The DirectXMath quaternion functions use an XMVECTOR 4-vector to represent quaternions, where the X, Y, and Z components are the vector part and the W component is the scalar part.

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