`vec3`

Function

Builds a vec3 from three scalars, a vec2 and a scalar, or broadcasts a single scalar to all three components.

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

Syntax

declare function vec3<T = f32>(): VecFor3<T>
declare function vec3<T = f32>(x: number, y: number, z: number): VecFor3<T>
declare function vec3<T = f32>(v: vec2, z: number): VecFor3<T>
declare function vec3<T = f32>(x: number, v: vec2): VecFor3<T>
declare function vec3<T = f32>(scalar: number): VecFor3<T>
declare function vec3<T = f32>(v: vec3): VecFor3<T>
declare function vec3<T>(x: bool, y: bool, z: bool): VecFor3<T>
declare function vec3<T>(scalar: bool): VecFor3<T>
declare function vec3<T = f32>(v: vec3i): VecFor3<T>
declare function vec3<T = f32>(v: vec3u): VecFor3<T>
declare function vec3<T = f32>(v: vec3b): VecFor3<T>
declare function vec3(v: vec3f64): vec3

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.

VecFor3: type VecFor3<T> = VecElemOf<T, vec3u, vec3i, vec3f64, vec3b, vec3>

Parameters

x optional numberbool
v optional vec2vec3vec3ivec3uvec3bvec3f64
scalar optional numberbool
y optional numberbool
z optional numberbool

Return value

VecFor3<T>vec3

`vec3`

Syntax

Parameters

Return value

Examples

See also

Report a problem