D3DXQuaternionRotationAxis function (D3DX10Math.h)
Note
The D3DX10 utility library is deprecated. We recommend that you use DirectXMath instead.
Rotates a quaternion about an arbitrary axis.
Syntax
D3DXQUATERNION* D3DXQuaternionRotationAxis(
_Inout_ D3DXQUATERNION *pOut,
_In_ const D3DXVECTOR3 *pV,
_In_ FLOAT Angle
);
Parameters
-
pOut [in, out]
-
Type: D3DXQUATERNION*
Pointer to the D3DXQUATERNION that is the result of the operation.
-
pV [in]
-
Type: const D3DXVECTOR3*
Pointer to the D3DXVECTOR3 that identifies the axis about which to rotate the quaternion.
-
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: D3DXQUATERNION*
Pointer to a D3DXQUATERNION 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 D3DXQuaternionRotationAxis function can be used as a parameter for another function.
Use D3DXQuaternionNormalize for any quaternion input that is not already normalized.
Requirements
Requirement | Value |
---|---|
Header |
|
Library |
|
See also