mirror of
https://github.com/g-truc/glm.git
synced 2024-09-20 16:32:16 +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.8"/>
|
|
<title>0.9.6: 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 style="padding-left: 0.5em;">
|
|
<div id="projectname">0.9.6
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.8 -->
|
|
<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_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_153b03dd71a7bff437c38ec53cb2e014.html">Source</a></li><li class="navelem"><a class="el" href="dir_0c6652232a835be54bedd6cfd7502504.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e2c7faa62a52820b5be8795affd6e495.html">glm</a></li><li class="navelem"><a class="el" href="dir_5cf96241cdcf6779b80e104875f9716f.html">glm</a></li><li class="navelem"><a class="el" href="dir_9b22c367036d391e575f56d067c9855b.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="a00030.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="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include "<a class="code" href="a00134.html">type_vec3.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">namespace </span><a class="code" href="a00145.html">glm</a></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</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="l00056"></a><span class="lineno"> 56</span>  GLM_FUNC_DECL T <a class="code" href="a00151.html#ga18d45e3d4c7705e67ccfabd99e521604">length</a>(</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  vecType<T, P> <span class="keyword">const</span> & x);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</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="l00066"></a><span class="lineno"> 66</span>  GLM_FUNC_DECL T <a class="code" href="a00151.html#ga7ca317dde0d7e94d920153554d4a02a8">distance</a>(</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  vecType<T, P> <span class="keyword">const</span> & p0,</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  vecType<T, P> <span class="keyword">const</span> & p1);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</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="l00077"></a><span class="lineno"> 77</span>  GLM_FUNC_DECL T <a class="code" href="a00151.html#ga7dada304da2ba7dd3376ab4f178c3f6b">dot</a>(</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  vecType<T, P> <span class="keyword">const</span> & x,</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  vecType<T, P> <span class="keyword">const</span> & y);</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, precision P></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  GLM_FUNC_DECL tvec3<T, P> <a class="code" href="a00151.html#gafe2cae8cb26fd44be62aee97369d0af8">cross</a>(</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  tvec3<T, P> <span class="keyword">const</span> & x,</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  tvec3<T, P> <span class="keyword">const</span> & y);</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</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="l00098"></a><span class="lineno"> 98</span>  GLM_FUNC_DECL vecType<T, P> <a class="code" href="a00151.html#gada9451ec170a36fe53552812b9c03a68">normalize</a>(</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  vecType<T, P> <span class="keyword">const</span> & x);</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  GLM_FUNC_DECL genType <a class="code" href="a00151.html#ga4bbb036ef9527ee9f67384233029ed9b">faceforward</a>(</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  genType <span class="keyword">const</span> & N,</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  genType <span class="keyword">const</span> & I,</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  genType <span class="keyword">const</span> & Nref);</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  GLM_FUNC_DECL genType <a class="code" href="a00151.html#gab63646fc36b81cf69d3ce123a72f76f2">reflect</a>(</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  genType <span class="keyword">const</span> & I,</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  genType <span class="keyword">const</span> & N);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</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="l00134"></a><span class="lineno"> 134</span>  GLM_FUNC_DECL vecType<T, P> <a class="code" href="a00151.html#gab7e7cdf4403931a5f7b74560ad64159b">refract</a>(</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  vecType<T, P> <span class="keyword">const</span> & I,</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  vecType<T, P> <span class="keyword">const</span> & N,</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  T eta);</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> }<span class="comment">//namespace glm</span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#include "func_geometric.inl"</span></div>
|
|
<div class="ttc" id="a00151_html_gab7e7cdf4403931a5f7b74560ad64159b"><div class="ttname"><a href="a00151.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 class="ttc" id="a00151_html_gab63646fc36b81cf69d3ce123a72f76f2"><div class="ttname"><a href="a00151.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="a00151_html_ga7ca317dde0d7e94d920153554d4a02a8"><div class="ttname"><a href="a00151.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="a00151_html_ga4bbb036ef9527ee9f67384233029ed9b"><div class="ttname"><a href="a00151.html#ga4bbb036ef9527ee9f67384233029ed9b">glm::faceforward</a></div><div class="ttdeci">GLM_FUNC_DECL genType faceforward(genType const &N, genType const &I, genType const &Nref)</div><div class="ttdoc">If dot(Nref, I) < 0.0, return N, otherwise, return -N. </div></div>
|
|
<div class="ttc" id="a00151_html_ga7dada304da2ba7dd3376ab4f178c3f6b"><div class="ttname"><a href="a00151.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="a00134_html"><div class="ttname"><a href="a00134.html">type_vec3.hpp</a></div><div class="ttdoc">OpenGL Mathematics (glm.g-truc.net) </div></div>
|
|
<div class="ttc" id="a00151_html_ga18d45e3d4c7705e67ccfabd99e521604"><div class="ttname"><a href="a00151.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="a00151_html_gada9451ec170a36fe53552812b9c03a68"><div class="ttname"><a href="a00151.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="a00151_html_gafe2cae8cb26fd44be62aee97369d0af8"><div class="ttname"><a href="a00151.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="a00145_html"><div class="ttname"><a href="a00145.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00039">_noise.hpp:39</a></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.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|