XMQuaternionRotationAxis function (directxmath.h)

Article
02/22/2024

Computes a rotation quaternion about an axis.

Syntax

XMVECTOR XM_CALLCONV XMQuaternionRotationAxis(
  [in] FXMVECTOR Axis,
  [in] float     Angle
) noexcept;

Parameters

[in] Axis

3D vector describing the axis of rotation.

[in] Angle

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

Return value

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

Platform Requirements

Microsoft Visual Studio 2010 or Microsoft Visual Studio 2012 with the Windows SDK for Windows 8. Supported for Win32 desktop apps, Windows Store apps, and Windows Phone 8 apps.

Requirements

Requirement	Value
Target Platform	Windows
Header	directxmath.h