XMQuaternionLn function (directxmath.h)

Computes the natural logarithm of a given unit quaternion.

Syntax

XMVECTOR XM_CALLCONV XMQuaternionLn(
  [in] FXMVECTOR Q
) noexcept;

Parameters

[in] Q

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

Return value

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.

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 Quaternion Functions