XMQuaternionToAxisAngle function (directxmath.h)

Article
02/22/2024

Computes an axis and angle of rotation about that axis for a given quaternion.

Syntax

void XM_CALLCONV XMQuaternionToAxisAngle(
  [out] XMVECTOR  *pAxis,
  [out] float     *pAngle,
  [in]  FXMVECTOR Q
) noexcept;

Parameters

[out] pAxis

Address of a 3D vector describing the axis of rotation for the quaternion Q.

[out] pAngle

Address of float describing the radian angle of rotation for the quaternion Q.

[in] Q

Quaternion to measure.

Return value

None.

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.

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

Share via