XMQuaternionIsIdentity function

Tests whether a specific quaternion is the identity quaternion.

Syntax

bool XM_CALLCONV XMQuaternionIsIdentity(
  FXMVECTOR Q
);

Parameters

Q

Quaternion to test.

Return Value

Returns true if Q is the identity quaternion, or 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

   
Target Platform Windows
Header directxmath.h

See Also

DirectXMath Library Quaternion Functions