TypeShade
distance
Function
Returns the Euclidean distance between a and b, computed as length(a - b).
The signature and the sentence under each name are the compiler's own text at commit 26de7be8.
Syntax
declare function distance<V extends vec2 | vec3 | vec4>(a0: V, a1: V): (f32)declare function distance<P0 extends number, P1 extends number>(a0: P0, a1: P1): ([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 : ([P1] extends [boolean] ? bool : typeof f32Tag extends keyof P1 ? f32 : typeof i32Tag extends keyof P1 ? i32 : typeof u32Tag extends keyof P1 ? u32 : typeof f64Tag extends keyof P1 ? f64 : number))declare function distance<T extends Numeric | Vec64Any>(a0: T, a1: T): T extends Vec64Any ? f64 : numberA 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.
Vec64Anytype Vec64Any = vec2f64 | vec3f64 | vec4f64Numerictype Numeric = number | vec2 | vec3 | vec4 | vec2i | vec3i | vec4i | vec2u | vec3u | vec4u
Parameters
A parameter named by position (a0, a1) carries a name the ambient file generates. A call passes its arguments in order and names none of them.
-
a0VP0T -
a1VP1T
Return value
(f32)([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 : ([P1] extends [boolean] ? bool : typeof f32Tag extends keyof P1 ? f32 : typeof i32Tag extends keyof P1 ? i32 : typeof u32Tag extends keyof P1 ? u32 : typeof f64Tag extends keyof P1 ? f64 : number))T extends Vec64Any ? f64 : number
Description
Targets
- WGSL
-
distance(a, b) - GLSL ES 3.00
-
distance(a, b)