XMQuaternionLn

Computes the natural logarithm of a given unit quaternion.

Syntax

XMVECTOR XMQuaternionLn(
         XMVECTOR Q
)  

Parameters

Q
Type: XMVECTOR 

Unit quaternion for which to calculate the natural logarithm. If Q is not a unit quaternion, the returned value is undefined.

Return value

Type: XMVECTOR 

Returns the natural logarithm of Q.

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.

Requirements

Header: Declared in directxmath.h.