D3DXMatrixRotationAxis function (D3dx9math.h)

Article
04/28/2022

Note

The D3DX utility library is deprecated. We recommend that you use DirectXMath instead.

Builds a matrix that rotates around an arbitrary axis.

Syntax

D3DXMATRIX* D3DXMatrixRotationAxis(
  _Inout_       D3DXMATRIX  *pOut,
  _In_    const D3DXVECTOR3 *pV,
  _In_          FLOAT       Angle
);

Parameters

pOut [in, out]

Type: D3DXMATRIX*

Pointer to the D3DXMATRIX structure that is the result of the operation.

pV [in]

Type: const D3DXVECTOR3*

Pointer to the arbitrary axis. See D3DXVECTOR3.

Angle [in]

Type: FLOAT

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

Return value

Type: D3DXMATRIX*

Pointer to a D3DXMATRIX 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 D3DXMatrixRotationAxis function can be used as a parameter for another function.

Requirements

Requirement	Value
Header	D3dx9math.h
Library	D3dx9.lib