XMQuaternionRotationAxis

Computes a rotation quaternion about an axis.

Syntax

XMVECTOR XMQuaternionRotationAxis(
         XMVECTOR Axis,
         float Angle
)  

Parameters

Axis
Type: XMVECTOR 

3D vector describing the axis of rotation.

Angle
Type: float 

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

Return value

Type: XMVECTOR 

Returns the rotation 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.

If Axis is a normalized vector, it is faster to use XMQuaternionRotationNormal

Requirements

Header: Declared in directxmath.h.