XMVectorATan2 method

Computes the arctangent of Y/X.

Syntax


XMVECTOR XMVectorATan2(
  [in] XMVECTOR Y,
  [in] XMVECTOR X
);

Parameters

Y [in]

First vector.

X [in]

Second vector.

Return value

Returns a vector. Each component is the arctangent of the corresponding Y component divided by the corresponding X component. Each component is in the range (-PI/2, PI/2).

XMVectorATan2 returns the following values for the specified special input values.

Input ValueReturn Value
Y == 0 and X < 0Pi with the same sign as Y
Y == 0 and X > 00 with the same sign as Y
Y != 0 and X == 0Pi / 2 with the same sign as Y
X == -Infinity and Y is finitePi with the same sign as Y
X == +Infinity and Y is finite0 with the same sign as Y
Y == Infinity and X is finitePi / 2 with the same sign as Y
Y == Infinity and X == -Infinity3Pi / 4 with the same sign as Y
Y == Infinity and X == +InfinityPi / 4 with the same sign as Y

 

Remarks

This function uses a 17-degree minimax approximation.

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

Namespace

Use DirectX.

Header

DirectXMath.h

See also

Transcendental Vector Functions
XMVectorATan
XMVectorATan2Est
XMVectorATanEst
XMVectorTan

 

 

Show: