TypeShade
mod
Function
Returns the floor-modulo remainder of x divided by y, with the sign of y, componentwise over vectors.
The signature and the sentence under each name are the compiler's own text at commit 26de7be8.
Syntax
declare function mod(a0: number, a1: number): numberdeclare function mod<T extends Numeric>(a0: T, a1: T): TA 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.
Numerictype 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.
-
a0numberT -
a1numberT
Return value
numberT
Description
mod(-7, 3) returns 2, not -1 like the % operator, which uses truncating modulo.
Targets
- WGSL
-
(a - b * floor(a / b)) - GLSL ES 3.00
-
mod(a, b)