1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
[//]: # (generated using SlashBack 0.2.0)
# func\_geometric methods
The following methods are all part of the **func\_geometric methods**\.
These operate on vectors as vectors, not component\-wise\.
## Table of contents
* [**cross** function](#cross-function)
* [**distance** function](#distance-function)
* [**dot** function](#dot-function)
* [**faceforward** function](#faceforward-function)
* [**length** function](#length-function)
* [**normalize** function](#normalize-function)
* [**reflect** function](#reflect-function)
* [**refract** function](#refract-function)
### cross\(\) function
#### <code>glm.<code>**cross**(**x**: *vec3*, **y**: *vec3*) -\> *vec3*</code></code>
  Returns the cross product of ``` x ``` and ``` y ```\.
#### <code>glm.<code>**cross**(**x**: *quat*, **y**: *quat*) -\> *quat*</code></code>
  Compute a cross product\.
### distance\(\) function
#### <code>glm.<code>**distance**(**p0**: *float*, **p1**: *float*) -\> *float*</code></code>
  Returns the distance between ``` p0 ``` and ``` p1 ```, i\.e\., ``` length(p0 - p1) ```\.
#### <code>glm.<code>**distance**(**p0**: *vecN*, **p1**: *vecN*) -\> *float*</code></code>
  Returns the distance between ``` p0 ``` and ``` p1 ```, i\.e\., ``` length(p0 - p1) ```\.
### dot\(\) function
#### <code>glm.<code>**dot**(**x**: *number*, **y**: *number*) -\> *float*</code></code>
  Returns the dot product of ``` x ``` and ``` y ```, i\.e\., ``` result = x * y ```\.
#### <code>glm.<code>**dot**(**x**: *vecN*, **y**: *vecN*) -\> *number*</code></code>
  Returns the dot product of ``` x ``` and ``` y ```, i\.e\., ``` result = x[0] * y[0] + x[1] * y[1] + ... ```
#### <code>glm.<code>**dot**(**x**: *quat*, **y**: *quat*) -\> *float*</code></code>
  Returns dot product of ``` x ``` and ``` y ```, i\.e\., ``` x[0] * y[0] + x[1] * y[1] + ... ```
### faceforward\(\) function
#### <code>glm.<code>**faceforward**(**N**: *float*, **I**: *float*, **Nref**: *float*) -\> *float*</code></code>
  If ``` dot(Nref, I) < 0.0 ```, return ``` N ```, otherwise, return ``` -N ```\.
#### <code>glm.<code>**faceforward**(**N**: *vecN*, **I**: *vecN*, **Nref**: *vecN*) -\> *vecN*</code></code>
  For every index ``` i ```:
  If ``` dot(Nref[i], I[i]) < 0.0 ```, return ``` N[i] ```, otherwise, return ``` -N[i] ```\.
### length\(\) function
#### <code>glm.<code>**length**(**x**: *float*) -\> *float*</code></code>
  Returns the length of ``` x ```, i\.e\., ``` abs(x) ```\.
#### <code>glm.<code>**length**(**x**: *vecN*) -\> *float*</code></code>
  Returns the length of ``` x ```, i\.e\., ``` sqrt(x * x) ```\.
#### <code>glm.<code>**length**(**x**: *quat*) -\> *float*</code></code>
  Returns the norm of a quaternion\.
### normalize\(\) function
#### <code>glm.<code>**normalize**(**x**: *vecN*) -\> *vecN*</code></code>
  Returns a vector in the same direction as ``` x ``` but with length of ``` 1 ```\.
#### <code>glm.<code>**normalize**(**x**: *quat*) -\> *quat*</code></code>
  Returns the normalized quaternion\.
### reflect\(\) function
#### <code>glm.<code>**reflect**(**I**: *float*, **N**: *float*) -\> *float*</code></code>
  For the incident vector ``` I ``` and surface orientation ``` N ```, returns the reflection direction:
  ``` result = I - 2.0 * dot(N, I) * N ```\.
#### <code>glm.<code>**reflect**(**I**: *vecN*, **N**: *vecN*) -\> *vecN*</code></code>
  For the incident vector ``` I ``` and surface orientation ``` N ```, returns the reflection direction:
  ``` result = I - 2.0 * dot(N, I) * N ```\.
### refract\(\) function
#### <code>glm.<code>**refract**(**I**: *float*, **N**: *float*, **eta**: *float*) -\> *float*</code></code>
  For the incident vector ``` I ``` and surface normal ``` N ```, and the ratio of indices of refraction ``` eta ```,
  return the refraction vector\.
#### <code>glm.<code>**refract**(**I**: *vecN*, **N**: *vecN*, **eta**: *float*) -\> *vecN*</code></code>
  For the incident vector ``` I ``` and surface normal ``` N ```, and the ratio of indices of refraction ``` eta ```,
  return the refraction vector\.
|
