devela::_dep::sdl3::sys::stdinc

Function SDL_atan

pub unsafe extern "C" fn SDL_atan(x: f64) -> f64 ⓘ
Available on crate feature dep_sdl3 only.
Expand description

Compute the arc tangent of x.

The definition of y = atan(x) is x = tan(y).

Domain: -INF <= x <= INF

Range: -Pi/2 <= y <= Pi/2

This function operates on double-precision floating point values, use SDL_atanf for single-precision floats.

To calculate the arc tangent of y / x, use SDL_atan2.

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.

§Parameters

  • x: floating point value.

§Return value

Returns arc tangent of of x in radians, or 0 if x = 0.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also