XMMatrixRotationAxis function (directxmath.h)

Builds a matrix that rotates around an arbitrary axis.

Syntax

XMMATRIX XM_CALLCONV XMMatrixRotationAxis(
  [in] FXMVECTOR Axis,
  [in] float     Angle
) noexcept;

Parameters

[in] Axis

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 matrix.

Remarks

If Axis is a normalized vector, it is faster to use the XMMatrixRotationNormal function to build this type of matrix.

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

See also

DirectXMath Library Matrix Functions