Updated API doc
This commit is contained in:
Christophe Riccio
@@ -4,7 +4,7 @@
|
||||
<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 File Reference</title>
|
||||
<title>0.9.9 API documenation: geometric.hpp File Reference</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>
|
||||
@@ -79,62 +79,62 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
|
||||
<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>
|
||||
<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> </ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">func_geometric.hpp File Reference</div> </div>
|
||||
<div class="title">geometric.hpp File Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p><a class="el" href="a00158.html">GLM Core</a>
|
||||
<p><a class="el" href="a00143.html">Core features</a>
|
||||
<a href="#details">More...</a></p>
|
||||
|
||||
<p><a href="a00034_source.html">Go to the source code of this file.</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:gaf48bb3113e27775dfa907960a6927d33"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gaf48bb3113e27775dfa907960a6927d33"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaf48bb3113e27775dfa907960a6927d33">cross</a> (vec< 3, T, P > const &x, vec< 3, T, P > const &y)</td></tr>
|
||||
<tr class="memdesc:gaf48bb3113e27775dfa907960a6927d33"><td class="mdescLeft"> </td><td class="mdescRight">Returns the cross product of x and y. <a href="a00150.html#gaf48bb3113e27775dfa907960a6927d33">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaf48bb3113e27775dfa907960a6927d33"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gadb370a015ab4c544ddd2cb0b2ea1cec8"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gadb370a015ab4c544ddd2cb0b2ea1cec8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gadb370a015ab4c544ddd2cb0b2ea1cec8">distance</a> (vec< L, T, P > const &p0, vec< L, T, P > const &p1)</td></tr>
|
||||
<tr class="memdesc:gadb370a015ab4c544ddd2cb0b2ea1cec8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). <a href="a00150.html#gadb370a015ab4c544ddd2cb0b2ea1cec8">More...</a><br /></td></tr>
|
||||
<tr class="separator:gadb370a015ab4c544ddd2cb0b2ea1cec8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7">dot</a> (vec< L, T, P > const &x, vec< L, T, P > const &y)</td></tr>
|
||||
<tr class="memdesc:gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dot product of x and y, i.e., result = x * y. <a href="a00150.html#gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa51a3aaf29f7c5bd2adb3d7fb9bad3c7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga4b1a93be2515b8de5ba413eb636396da"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga4b1a93be2515b8de5ba413eb636396da"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga4b1a93be2515b8de5ba413eb636396da">faceforward</a> (vec< L, T, P > const &N, vec< L, T, P > const &I, vec< L, T, P > const &Nref)</td></tr>
|
||||
<tr class="memdesc:ga4b1a93be2515b8de5ba413eb636396da"><td class="mdescLeft"> </td><td class="mdescRight">If dot(Nref, I) < 0.0, return N, otherwise, return -N. <a href="a00150.html#ga4b1a93be2515b8de5ba413eb636396da">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga4b1a93be2515b8de5ba413eb636396da"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga9363516a0cffaa7c44adea39d2b0334d"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga9363516a0cffaa7c44adea39d2b0334d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga9363516a0cffaa7c44adea39d2b0334d">length</a> (vec< L, T, P > const &x)</td></tr>
|
||||
<tr class="memdesc:ga9363516a0cffaa7c44adea39d2b0334d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of x, i.e., sqrt(x * x). <a href="a00150.html#ga9363516a0cffaa7c44adea39d2b0334d">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9363516a0cffaa7c44adea39d2b0334d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga8263c6c2b8ff1719c89728d643bba27a"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga8263c6c2b8ff1719c89728d643bba27a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga8263c6c2b8ff1719c89728d643bba27a">normalize</a> (vec< L, T, P > const &x)</td></tr>
|
||||
<tr class="memdesc:ga8263c6c2b8ff1719c89728d643bba27a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector in the same direction as x but with length of 1. <a href="a00150.html#ga8263c6c2b8ff1719c89728d643bba27a">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga8263c6c2b8ff1719c89728d643bba27a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gad0ef4d78d209c4a3f90b9df53afa23a9"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gad0ef4d78d209c4a3f90b9df53afa23a9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gad0ef4d78d209c4a3f90b9df53afa23a9">reflect</a> (vec< L, T, P > const &I, vec< L, T, P > const &N)</td></tr>
|
||||
<tr class="memdesc:gad0ef4d78d209c4a3f90b9df53afa23a9"><td class="mdescLeft"> </td><td class="mdescRight">For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N. <a href="a00150.html#gad0ef4d78d209c4a3f90b9df53afa23a9">More...</a><br /></td></tr>
|
||||
<tr class="separator:gad0ef4d78d209c4a3f90b9df53afa23a9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae7fdf06db18e429a29c7d4169e8459be"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:gae7fdf06db18e429a29c7d4169e8459be"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gae7fdf06db18e429a29c7d4169e8459be">refract</a> (vec< L, T, P > const &I, vec< L, T, P > const &N, T eta)</td></tr>
|
||||
<tr class="memdesc:gae7fdf06db18e429a29c7d4169e8459be"><td class="mdescLeft"> </td><td class="mdescRight">For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector. <a href="a00150.html#gae7fdf06db18e429a29c7d4169e8459be">More...</a><br /></td></tr>
|
||||
<tr class="separator:gae7fdf06db18e429a29c7d4169e8459be"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaeeec0794212fe84fc9d261de067c9587"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gaeeec0794212fe84fc9d261de067c9587"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00142.html#gaeeec0794212fe84fc9d261de067c9587">cross</a> (vec< 3, T, Q > const &x, vec< 3, T, Q > const &y)</td></tr>
|
||||
<tr class="memdesc:gaeeec0794212fe84fc9d261de067c9587"><td class="mdescLeft"> </td><td class="mdescRight">Returns the cross product of x and y. <a href="a00142.html#gaeeec0794212fe84fc9d261de067c9587">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaeeec0794212fe84fc9d261de067c9587"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00142.html#gaa68de6c53e20dfb2dac2d20197562e3f">distance</a> (vec< L, T, Q > const &p0, vec< L, T, Q > const &p1)</td></tr>
|
||||
<tr class="memdesc:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). <a href="a00142.html#gaa68de6c53e20dfb2dac2d20197562e3f">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa68de6c53e20dfb2dac2d20197562e3f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaad6c5d9d39bdc0bf43baf1b22e147a0a"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gaad6c5d9d39bdc0bf43baf1b22e147a0a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00142.html#gaad6c5d9d39bdc0bf43baf1b22e147a0a">dot</a> (vec< L, T, Q > const &x, vec< L, T, Q > const &y)</td></tr>
|
||||
<tr class="memdesc:gaad6c5d9d39bdc0bf43baf1b22e147a0a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dot product of x and y, i.e., result = x * y. <a href="a00142.html#gaad6c5d9d39bdc0bf43baf1b22e147a0a">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaad6c5d9d39bdc0bf43baf1b22e147a0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga7aed0a36c738169402404a3a5d54e43b"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga7aed0a36c738169402404a3a5d54e43b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00142.html#ga7aed0a36c738169402404a3a5d54e43b">faceforward</a> (vec< L, T, Q > const &N, vec< L, T, Q > const &I, vec< L, T, Q > const &Nref)</td></tr>
|
||||
<tr class="memdesc:ga7aed0a36c738169402404a3a5d54e43b"><td class="mdescLeft"> </td><td class="mdescRight">If dot(Nref, I) < 0.0, return N, otherwise, return -N. <a href="a00142.html#ga7aed0a36c738169402404a3a5d54e43b">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga7aed0a36c738169402404a3a5d54e43b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00142.html#ga0cdabbb000834d994a1d6dc56f8f5263">length</a> (vec< L, T, Q > const &x)</td></tr>
|
||||
<tr class="memdesc:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of x, i.e., sqrt(x * x). <a href="a00142.html#ga0cdabbb000834d994a1d6dc56f8f5263">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga0cdabbb000834d994a1d6dc56f8f5263"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga3b8d3dcae77870781392ed2902cce597"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga3b8d3dcae77870781392ed2902cce597"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00142.html#ga3b8d3dcae77870781392ed2902cce597">normalize</a> (vec< L, T, Q > const &x)</td></tr>
|
||||
<tr class="memdesc:ga3b8d3dcae77870781392ed2902cce597"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector in the same direction as x but with length of 1. <a href="a00142.html#ga3b8d3dcae77870781392ed2902cce597">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga3b8d3dcae77870781392ed2902cce597"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00142.html#ga5631dd1d5618de5450b1ea3cf3e94905">reflect</a> (vec< L, T, Q > const &I, vec< L, T, Q > const &N)</td></tr>
|
||||
<tr class="memdesc:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="mdescLeft"> </td><td class="mdescRight">For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N. <a href="a00142.html#ga5631dd1d5618de5450b1ea3cf3e94905">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga5631dd1d5618de5450b1ea3cf3e94905"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00142.html#ga01da3dff9e2ef6b9d4915c3047e22b74">refract</a> (vec< L, T, Q > const &I, vec< L, T, Q > const &N, T eta)</td></tr>
|
||||
<tr class="memdesc:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="mdescLeft"> </td><td class="mdescRight">For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector. <a href="a00142.html#ga01da3dff9e2ef6b9d4915c3047e22b74">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga01da3dff9e2ef6b9d4915c3047e22b74"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p><a class="el" href="a00158.html">GLM Core</a> </p>
|
||||
<div class="textblock"><p><a class="el" href="a00143.html">Core features</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.5 Geometric Functions</a> </dd></dl>
|
||||
|
||||
<p>Definition in file <a class="el" href="a00034_source.html">func_geometric.hpp</a>.</p>
|
||||
<p>Definition in file <a class="el" href="a00034_source.html">geometric.hpp</a>.</p>
|
||||
</div></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user