D3DXQuaternionIdentity

The D3DXQuaternionIdentity function returns the identity quaternion.

D3DXQUATERNION* D3DXQuaternionIdentity(
  D3DXQUATERNION* pOut
); 

Parameters

pOut

A pointer to the D3DXQUATERNION structure that is the result of the operation.

Return Values

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Version: Requires DirectX 7.0.
  Header: Declared in d3dxmath.h.
  Library: Use d3dx.lib.

See Also

D3DXQuaternionIsIdentity