Edit

XMScalarModAngle function (directxmath.h)

  • Article

Computes an angle between -XM_PI and XM_PI.

Syntax

float XMScalarModAngle(
  [in] float Value
) noexcept;

Parameters

[in] Value

float value describing the radian angle.

Return value

Returns an angle greater than or equal to -XM_PI and less than XM_PI that is congruent to Value modulo 2pi.

Remarks

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