mirror of
https://github.com/patriciogonzalezvivo/thebookofshaders
synced 2024-11-11 13:10:57 +00:00
27 lines
712 B
Markdown
27 lines
712 B
Markdown
## Mod
|
|
Compute value of one parameter modulo another
|
|
|
|
### Declaration
|
|
```glsl
|
|
float mod(float x, float y)
|
|
vec2 mod(vec2 x, vec2 y)
|
|
vec3 mod(vec3 x, vec3 y)
|
|
vec4 mod(vec4 x, vec4 y)
|
|
|
|
vec2 mod(vec2 x, float y)
|
|
vec3 mod(vec3 x, float y)
|
|
vec4 mod(vec4 x, float y)
|
|
```
|
|
|
|
### Parameters
|
|
```x``` specify the value to evaluate.
|
|
```y``` specify the value to obtain the modulo of.
|
|
|
|
### Description
|
|
```mod()``` returns the value of ```x``` modulo ```y```. This is computed as ```x - y * floor(x/y)```.
|
|
|
|
<div class="simpleFunction" data="y = mod(x,1.5); "></div>
|
|
|
|
### See Also
|
|
[floor](/glossary/?search=floor), [fract](/glossary/?search=fract), [ceil](/glossary/?search=ceil), [Chapter 05: Shaping Functions](/05/)
|