mirror of
https://github.com/g-truc/glm.git
synced 2024-11-14 06:04:34 +00:00
122 lines
14 KiB
HTML
122 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.10"/>
|
|
<title>0.9.8: func_geometric.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">0.9.8
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_275089585c7fc1b5fd5d7d42c69cb1da.html">D:</a></li><li class="navelem"><a class="el" href="dir_7b98f88bffbed4b390b5f8f520d9c08e.html">Source</a></li><li class="navelem"><a class="el" href="dir_1f76e953200861345293ade84ac7fb6c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e29b03b892e0e25920d021a614d4db9b.html">glm</a></li><li class="navelem"><a class="el" href="dir_5ce58d942b2d0776e17a9a58abc01e04.html">glm</a></li><li class="navelem"><a class="el" href="dir_e529a619cfdec1fa4c331fb042fd332f.html">detail</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">func_geometric.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="a00031.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="a00130.html">type_vec3.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span><a class="code" href="a00141.html">glm</a></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> <<span class="keyword">typename</span>, precision> <span class="keyword">class </span>vecType></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  GLM_FUNC_DECL T <a class="code" href="a00148.html#ga18d45e3d4c7705e67ccfabd99e521604">length</a>(</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  vecType<T, P> <span class="keyword">const</span> & x);</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> <<span class="keyword">typename</span>, precision> <span class="keyword">class </span>vecType></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  GLM_FUNC_DECL T <a class="code" href="a00148.html#ga7ca317dde0d7e94d920153554d4a02a8">distance</a>(</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  vecType<T, P> <span class="keyword">const</span> & p0,</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  vecType<T, P> <span class="keyword">const</span> & p1);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> <<span class="keyword">typename</span>, precision> <span class="keyword">class </span>vecType></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  GLM_FUNC_DECL T <a class="code" href="a00148.html#ga7dada304da2ba7dd3376ab4f178c3f6b">dot</a>(</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  vecType<T, P> <span class="keyword">const</span> & x,</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  vecType<T, P> <span class="keyword">const</span> & y);</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  GLM_FUNC_DECL tvec3<T, P> <a class="code" href="a00148.html#gafe2cae8cb26fd44be62aee97369d0af8">cross</a>(</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  tvec3<T, P> <span class="keyword">const</span> & x,</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  tvec3<T, P> <span class="keyword">const</span> & y);</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> <<span class="keyword">typename</span>, precision> <span class="keyword">class </span>vecType></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  GLM_FUNC_DECL vecType<T, P> <a class="code" href="a00148.html#gada9451ec170a36fe53552812b9c03a68">normalize</a>(</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  vecType<T, P> <span class="keyword">const</span> & x);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> <<span class="keyword">typename</span>, precision> <span class="keyword">class </span>vecType></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  GLM_FUNC_DECL vecType<T, P> <a class="code" href="a00148.html#gaea854e5aec1b5839832ac2dfc7cd3c0d">faceforward</a>(</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  vecType<T, P> <span class="keyword">const</span> & N,</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  vecType<T, P> <span class="keyword">const</span> & I,</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  vecType<T, P> <span class="keyword">const</span> & Nref);</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  GLM_FUNC_DECL genType <a class="code" href="a00148.html#gab63646fc36b81cf69d3ce123a72f76f2">reflect</a>(</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  genType <span class="keyword">const</span> & I,</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  genType <span class="keyword">const</span> & N);</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> <<span class="keyword">typename</span>, precision> <span class="keyword">class </span>vecType></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  GLM_FUNC_DECL vecType<T, P> <a class="code" href="a00148.html#gab7e7cdf4403931a5f7b74560ad64159b">refract</a>(</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  vecType<T, P> <span class="keyword">const</span> & I,</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  vecType<T, P> <span class="keyword">const</span> & N,</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  T eta);</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> }<span class="comment">//namespace glm</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#include "func_geometric.inl"</span></div>
|
|
<div class="ttc" id="a00130_html"><div class="ttname"><a href="a00130.html">type_vec3.hpp</a></div><div class="ttdoc">GLM Core </div></div>
|
|
<div class="ttc" id="a00141_html"><div class="ttname"><a href="a00141.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
|
|
<div class="ttc" id="a00148_html_ga7dada304da2ba7dd3376ab4f178c3f6b"><div class="ttname"><a href="a00148.html#ga7dada304da2ba7dd3376ab4f178c3f6b">glm::dot</a></div><div class="ttdeci">GLM_FUNC_DECL T dot(vecType< T, P > const &x, vecType< T, P > const &y)</div><div class="ttdoc">Returns the dot product of x and y, i.e., result = x * y. </div></div>
|
|
<div class="ttc" id="a00148_html_gafe2cae8cb26fd44be62aee97369d0af8"><div class="ttname"><a href="a00148.html#gafe2cae8cb26fd44be62aee97369d0af8">glm::cross</a></div><div class="ttdeci">GLM_FUNC_DECL tvec3< T, P > cross(tvec3< T, P > const &x, tvec3< T, P > const &y)</div><div class="ttdoc">Returns the cross product of x and y. </div></div>
|
|
<div class="ttc" id="a00148_html_gab63646fc36b81cf69d3ce123a72f76f2"><div class="ttname"><a href="a00148.html#gab63646fc36b81cf69d3ce123a72f76f2">glm::reflect</a></div><div class="ttdeci">GLM_FUNC_DECL genType reflect(genType const &I, genType const &N)</div><div class="ttdoc">For the incident vector I and surface orientation N, returns the reflection direction : result = I - ...</div></div>
|
|
<div class="ttc" id="a00148_html_gaea854e5aec1b5839832ac2dfc7cd3c0d"><div class="ttname"><a href="a00148.html#gaea854e5aec1b5839832ac2dfc7cd3c0d">glm::faceforward</a></div><div class="ttdeci">GLM_FUNC_DECL vecType< T, P > faceforward(vecType< T, P > const &N, vecType< T, P > const &I, vecType< T, P > const &Nref)</div><div class="ttdoc">If dot(Nref, I) < 0.0, return N, otherwise, return -N. </div></div>
|
|
<div class="ttc" id="a00148_html_gada9451ec170a36fe53552812b9c03a68"><div class="ttname"><a href="a00148.html#gada9451ec170a36fe53552812b9c03a68">glm::normalize</a></div><div class="ttdeci">GLM_FUNC_DECL vecType< T, P > normalize(vecType< T, P > const &x)</div><div class="ttdoc">Returns a vector in the same direction as x but with length of 1. </div></div>
|
|
<div class="ttc" id="a00148_html_ga7ca317dde0d7e94d920153554d4a02a8"><div class="ttname"><a href="a00148.html#ga7ca317dde0d7e94d920153554d4a02a8">glm::distance</a></div><div class="ttdeci">GLM_FUNC_DECL T distance(vecType< T, P > const &p0, vecType< T, P > const &p1)</div><div class="ttdoc">Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). </div></div>
|
|
<div class="ttc" id="a00148_html_ga18d45e3d4c7705e67ccfabd99e521604"><div class="ttname"><a href="a00148.html#ga18d45e3d4c7705e67ccfabd99e521604">glm::length</a></div><div class="ttdeci">GLM_FUNC_DECL T length(vecType< T, P > const &x)</div><div class="ttdoc">Returns the length of x, i.e., sqrt(x * x). </div></div>
|
|
<div class="ttc" id="a00148_html_gab7e7cdf4403931a5f7b74560ad64159b"><div class="ttname"><a href="a00148.html#gab7e7cdf4403931a5f7b74560ad64159b">glm::refract</a></div><div class="ttdeci">GLM_FUNC_DECL vecType< T, P > refract(vecType< T, P > const &I, vecType< T, P > const &N, T eta)</div><div class="ttdoc">For the incident vector I and surface normal N, and the ratio of indices of refraction eta...</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|