XMQuaternionIdentity

Returns the identity quaternion.

Syntax

XMVECTOR XMQuaternionIdentity()  

Return value

Type: XMVECTOR 

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).

Requirements

Header: Declared in directxmath.h.