D3DXQuaternionIdentity

Returns the identity quaternion.

D3DXQUATERNION * D3DXQuaternionIdentity(
  D3DXQUATERNION * pOut
);

Parameters

pOut

[in, out] Pointer to the D3DXQUATERNION structure that is the result of the operation.

Return Values

Pointer to the D3DXQUATERNION structure that is the identity quaternion.

Remarks

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

The return value for this function is the same value returned in the pOut parameter. In this way, the D3DXQuaternionIdentity function can be used as a parameter for another function.

Use D3DXQuaternionNormalize for any quaternion input that is not already normalized.

Requirements

Header: Declared in D3dx9math.h.

See Also

D3DXQuaternionIsIdentity