atan
On this page

atan

Function

Returns the arctangent of x (in radians), componentwise over vectors.

The signature and the sentence under each name are the compiler's own text at commit 26de7be8.

Syntax

declare function atan<V extends vec2 | vec3 | vec4>(a0: V): V
declare function atan<P0 extends number>(a0: P0): ([P0] extends [boolean] ? bool : typeof f32Tag extends keyof P0 ? f32 : typeof i32Tag extends keyof P0 ? i32 : typeof u32Tag extends keyof P0 ? u32 : typeof f64Tag extends keyof P0 ? f64 : number)
declare function atan<T extends Numeric>(a0: T): T
declare function atan<T extends Numeric>(y: T, x: T): T

A number in a parameter or a return position is the scalar slot. The ambient file declares a GPU scalar as a branded number whose brand is optional, so a literal and any branded scalar both fill it.

type f32 = number & { readonly [f32Tag]?: true }

A declaration you write still needs a width, and a bare number on a field or a parameter is refused; the TypeScript constructs page carries that row with the compiler's own message.

A signature may name a type the ambient file declares for its own use. These are those declarations.

Numeric
type Numeric = number | vec2 | vec3 | vec4 | vec2i | vec3i | vec4i | vec2u | vec3u | vec4u

Parameters

  • y VP0T
  • x optional T

Return value

V([P0] extends [boolean] ? bool : typeof f32Tag extends keyof P0 ? f32 : typeof i32Tag extends keyof P0 ? i32 : typeof u32Tag extends keyof P0 ? u32 : typeof f64Tag extends keyof P0 ? f64 : number)T

Description

Targets

WGSL
atan(a)
GLSL ES 3.00
atan(a)

Examples

See also

Edit this page Report a problem