D3DXQuaternionRotationAxis

The D3DXQuaternionRotationAxis function rotates a given quaternion about an arbitrary axis.

D3DXQUATERNION* D3DXQuaternionRotationAxis(
  D3DXQUATERNION* pOut,
  const D3DXVECTOR3* pV,
  float angle
); 

Parameters

pOut

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

pV

A pointer to the D3DXVECTOR3 structure that identifies the axis angle.

angle

The angle of rotation, in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.

Return Values

A pointer to a D3DXQUATERNION structure rotated around the specified axis.

Remarks

The return value for this function is the same value returned in the pOut parameter. In this way, the D3DXQuaternionRotationAxis 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.
  Version: Requires DirectX 7.0.
  Header: Declared in d3dxmath.h.
  Library: Use d3dx.lib.

See Also

D3DXQuaternionRotationMatrix, D3DXQuaternionRotationYawPitchRoll