D3DXQuaternionLn Function

Calculates the natural logarithm.

Syntax

D3DXQUATERNION *D3DXQuaternionLn(      

    D3DXQUATERNION *pOut,
    CONST D3DXQUATERNION *pQ
);

Parameters

pOut
[in, out] Pointer to the D3DXQUATERNION structure that is the result of the operation.
pQ
[in] Pointer to the source D3DXQUATERNION structure.

Return Value

Pointer to a D3DXQUATERNION structure that is the natural logarithm.

Remarks

The D3DXQuaternionLn function works only for unit quaternions.
A unit quaternion, is defined by:
Q == (cos(theta), sin(theta) * v) where |v| = 1
The natural logarithm of Q is, ln(Q) = (0, theta * v)
The return value for this function is the same value returned in the pOut parameter. In this way, the D3DXQuaternionLn function can be used as a parameter for another function.

Function Information

Header d3dx9math.h
Import library d3dx9.lib
Minimum operating systems Windows 98

Header	d3dx9math.h
Import library	d3dx9.lib
Minimum operating systems	Windows 98