sdlAtan2 function
Compute the arc tangent of y / x
, using the signs of x and y to adjust
the result's quadrant.
The definition of z = atan2(x, y)
is y = x tan(z)
, where the quadrant
of z is determined based on the signs of x and y.
Domain: -INF <= x <= INF
, -INF <= y <= INF
Range: -Pi/2 <= y <= Pi/2
This function operates on double-precision floating point values, use SDL_atan2f for single-precision floats.
To calculate the arc tangent of a single value, use SDL_atan.
This function may use a different approximation across different versions, platforms and configurations. i.e, it can return a different value given the same input on different machines or operating systems, or if SDL is updated.
\param y floating point value of the numerator (y coordinate).
\param x floating point value of the denominator (x coordinate).
\returns arc tangent of of y / x
in radians, or, if x = 0
, either
-Pi/2
, 0
, or Pi/2
, depending on the value of y
.
\threadsafety It is safe to call this function from any thread.
\since This function is available since SDL 3.1.3.
\sa SDL_atan2f \sa SDL_atan \sa SDL_tan
extern SDL_DECLSPEC double SDLCALL SDL_atan2(double y, double x)
Implementation
double sdlAtan2(double y, double x) {
final sdlAtan2LookupFunction = libSdl3.lookupFunction<
Double Function(Double y, Double x),
double Function(double y, double x)>('SDL_atan2');
return sdlAtan2LookupFunction(y, x);
}