XMQuaternionIdentity function

Returns the identity quaternion.

Syntax

XMVECTOR XM_CALLCONV XMQuaternionIdentity(

);

Parameters

This function has no parameters.

Return Value

An XMVECTOR union that is the identity quaternion.

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.

Given a quaternion (x, y, z, w), the XMQuaternionIdentity function will return the quaternion (0, 0, 0, 1).

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