atan2

Description

Arc tangent of y/x. Returns the angle whose tangent is the quotient of two specified numbers.

Signature

T atan2<T>(
    T y,
    T x)
    where T : __BuiltinFloatingPointType;

vector<T, N> atan2<T, N:int>(
    vector<T, N> y,
    vector<T, N> x)
    where T : __BuiltinFloatingPointType;

matrix<T, N, M> atan2<T, N:int, M:int>(
    matrix<T, N, M> y,
    matrix<T, N, M> x)
    where T : __BuiltinFloatingPointType;

Generic Parameters

T: __BuiltinFloatingPointType

N : int

M : int

Parameters

y : T

The numerator.

x : T

The denominator.

y : vector<T, N>

The numerator.

x : vector<T, N>

The denominator.

y : matrix<T, N, M>

The numerator.

x : matrix<T, N, M>

The denominator.

Return value

The angle in radians, in the range of [-pi, pi].

Availability and Requirements

Defined for the following targets:

hlsl

Available in all stages.

glsl

Available in all stages.

cpp

Available in all stages.

cuda

Available in all stages.

metal

Available in all stages.

wgsl

Available in all stages.

spirv

Available in all stages.