atan

Description

Arc tangent. Returns the angle whose tangent is the specified number.

Signature

/// Requires Capability Set 1:
T atan<T>(T x)
    where T : __BuiltinFloatingPointType;

/// Requires Capability Set 1:
vector<T, N> atan<T, N:int>(vector<T, N> x)
    where T : __BuiltinFloatingPointType;

/// Requires Capability Set 1:
matrix<T, N, M> atan<T, N:int, M:int>(matrix<T, N, M> x)
    where T : __BuiltinFloatingPointType;

/// Requires Capability Set 2:
CoopVec<T, N> atan<T, N:int>(CoopVec<T, N> yOverX)
    where T : __BuiltinFloatingPointType;

Generic Parameters

T: __BuiltinFloatingPointType

N : int

M : int

Parameters

x : T

The tangent value.

x : vector<T, N>

The tangent value.

x : matrix<T, N, M>

The tangent value.

yOverX : CoopVec<T, N>

Return value

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

Availability and Requirements

Capability Set 1

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.

Capability Set 2

Defined for the following targets:

hlsl

Available in all stages.

cpp

Available in all stages.

cuda

Available in all stages.

spirv

Available in all stages.

Requires capability: spvCooperativeVectorNV.