XMQuaternionIdentity method

Returns the identity quaternion.

Syntax


XMVECTOR XMQuaternionIdentity();

Parameters

This method 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

Namespace	Use DirectX.
Header	DirectXMath.h