mirror of
https://github.com/g-truc/glm.git
synced 2024-11-30 11:54:36 +00:00
152 lines
14 KiB
HTML
152 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.9 API documenation: 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="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
</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="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">0.9.9 API documenation
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<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>
|
||
|
|
<li>
|
||
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
|
|
<span class="left">
|
||
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
alt=""/>
|
||
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
|
|
</span><span class="right">
|
||
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="navrow2" class="tabs2">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li><li class="navelem"><a class="el" href="dir_da256b9dd32ba43e2eaa8a2832c37f1b.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="a00034.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="a00131.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="a00143.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="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier P></div>
|
||
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  GLM_FUNC_DECL T <a class="code" href="a00150.html#ga9363516a0cffaa7c44adea39d2b0334d">length</a>(vec<L, 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="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier P></div>
|
||
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  GLM_FUNC_DECL T <a class="code" href="a00150.html#gadb370a015ab4c544ddd2cb0b2ea1cec8">distance</a>(vec<L, T, P> <span class="keyword">const</span>& p0, vec<L, T, P> <span class="keyword">const</span>& p1);</div>
|
||
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
||
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier P></div>
|
||
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  GLM_FUNC_DECL T <a class="code" href="a00150.html#gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7">dot</a>(vec<L, T, P> <span class="keyword">const</span> & x, vec<L, T, P> <span class="keyword">const</span> & y);</div>
|
||
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
||
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier P></div>
|
||
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  GLM_FUNC_DECL vec<3, T, P> <a class="code" href="a00150.html#gaf48bb3113e27775dfa907960a6927d33">cross</a>(vec<3, T, P> <span class="keyword">const</span> & x, vec<3, T, P> <span class="keyword">const</span> & y);</div>
|
||
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
|
||
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier P></div>
|
||
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  GLM_FUNC_DECL vec<L, T, P> <a class="code" href="a00150.html#ga8263c6c2b8ff1719c89728d643bba27a">normalize</a>(vec<L, T, P> <span class="keyword">const</span>& x);</div>
|
||
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
||
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier P></div>
|
||
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  GLM_FUNC_DECL vec<L, T, P> <a class="code" href="a00150.html#ga4b1a93be2515b8de5ba413eb636396da">faceforward</a>(</div>
|
||
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  vec<L, T, P> <span class="keyword">const</span>& N,</div>
|
||
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  vec<L, T, P> <span class="keyword">const</span>& I,</div>
|
||
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  vec<L, T, P> <span class="keyword">const</span>& Nref);</div>
|
||
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
|
||
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier P></div>
|
||
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  GLM_FUNC_DECL vec<L, T, P> <a class="code" href="a00150.html#gad0ef4d78d209c4a3f90b9df53afa23a9">reflect</a>(</div>
|
||
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  vec<L, T, P> <span class="keyword">const</span>& I,</div>
|
||
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  vec<L, T, P> <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="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier P></div>
|
||
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  GLM_FUNC_DECL vec<L, T, P> <a class="code" href="a00150.html#gae7fdf06db18e429a29c7d4169e8459be">refract</a>(</div>
|
||
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  vec<L, T, P> <span class="keyword">const</span>& I,</div>
|
||
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  vec<L, T, P> <span class="keyword">const</span>& N,</div>
|
||
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  T eta);</div>
|
||
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
|
||
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> }<span class="comment">//namespace glm</span></div>
|
||
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
|
||
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#include "func_geometric.inl"</span></div>
|
||
|
|
<div class="ttc" id="a00150_html_gad0ef4d78d209c4a3f90b9df53afa23a9"><div class="ttname"><a href="a00150.html#gad0ef4d78d209c4a3f90b9df53afa23a9">glm::reflect</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, P > reflect(vec< L, T, P > const &I, vec< L, T, P > 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="a00150_html_ga8263c6c2b8ff1719c89728d643bba27a"><div class="ttname"><a href="a00150.html#ga8263c6c2b8ff1719c89728d643bba27a">glm::normalize</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, P > normalize(vec< L, 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="a00150_html_gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><div class="ttname"><a href="a00150.html#gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7">glm::dot</a></div><div class="ttdeci">GLM_FUNC_DECL T dot(vec< L, T, P > const &x, vec< L, 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="a00150_html_ga4b1a93be2515b8de5ba413eb636396da"><div class="ttname"><a href="a00150.html#ga4b1a93be2515b8de5ba413eb636396da">glm::faceforward</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, P > faceforward(vec< L, T, P > const &N, vec< L, T, P > const &I, vec< L, 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="a00150_html_gae7fdf06db18e429a29c7d4169e8459be"><div class="ttname"><a href="a00150.html#gae7fdf06db18e429a29c7d4169e8459be">glm::refract</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, P > refract(vec< L, T, P > const &I, vec< L, 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="a00143_html"><div class="ttname"><a href="a00143.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="a00150_html_gadb370a015ab4c544ddd2cb0b2ea1cec8"><div class="ttname"><a href="a00150.html#gadb370a015ab4c544ddd2cb0b2ea1cec8">glm::distance</a></div><div class="ttdeci">GLM_FUNC_DECL T distance(vec< L, T, P > const &p0, vec< L, 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="a00150_html_ga9363516a0cffaa7c44adea39d2b0334d"><div class="ttname"><a href="a00150.html#ga9363516a0cffaa7c44adea39d2b0334d">glm::length</a></div><div class="ttdeci">GLM_FUNC_DECL T length(vec< L, T, P > const &x)</div><div class="ttdoc">Returns the length of x, i.e., sqrt(x * x). </div></div>
|
||
|
|
<div class="ttc" id="a00131_html"><div class="ttname"><a href="a00131.html">type_vec3.hpp</a></div><div class="ttdoc">GLM Core </div></div>
|
||
|
|
<div class="ttc" id="a00150_html_gaf48bb3113e27775dfa907960a6927d33"><div class="ttname"><a href="a00150.html#gaf48bb3113e27775dfa907960a6927d33">glm::cross</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 3, T, P > cross(vec< 3, T, P > const &x, vec< 3, T, P > const &y)</div><div class="ttdoc">Returns the cross product of x and y. </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>
|