Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

XMVectorATan2Est method

Estimates the arctangent of Y/X.

Syntax


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

Parameters

Y [in]

First vector.

X [in]

Second vector.

Return value

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

XMVectorATan2Est 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

Est functions offer increased performance at the expense of reduced accuracy. Est functions are appropriate for non-critical calculations where accuracy can be sacrificed for speed. The exact amount of lost accuracy and speed increase are platform dependent.

This function uses a 9-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

XMVectorATan
XMVectorATan2
XMVectorATanEst
XMVectorTan

 

 

Community Additions

Show:
© 2016 Microsoft