D3DXQuaternionRotationAxis

Rotates a quaternion about an arbitrary axis.

D3DXQUATERNION * D3DXQuaternionRotationAxis(
  D3DXQUATERNION * pOut,
  CONST D3DXVECTOR3 * pV,
  FLOAT Angle
);

Parameters

pOut

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

pV

[in] Pointer to the D3DXVECTOR3 structure that identifies the axis about which to rotate the quaternion.

Angle

[in] Angle of rotation, in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.

Return Values

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.

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

Requirements

Header: Declared in D3dx9math.h.

See Also

D3DXQuaternionRotationMatrix, D3DXQuaternionRotationYawPitchRoll