mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2016-09-11 12:44:33 +02:00
parent 9f0110f5b0
commit 454d480ceb
395 changed files with 58950 additions and 58068 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
doc/api/a00222.html
View File

@@ -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.7: GLM_GTX_polar_coordinates</title>
<title>0.9.8: GLM_GTX_raw_data</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>
@@ -18,7 +18,7 @@
<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.7
<div id="projectname">0.9.8
</div>
</td>
</tr>
@@ -37,60 +37,92 @@
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_polar_coordinates<div class="ingroups"><a class="el" href="a00161.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_raw_data<div class="ingroups"><a class="el" href="a00155.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga45ece1fbf7260c43e0f873c498202581"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga45ece1fbf7260c43e0f873c498202581"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00222.html#ga45ece1fbf7260c43e0f873c498202581">euclidean</a> (tvec2&lt; T, P &gt; const &amp;polar)</td></tr>
<tr class="separator:ga45ece1fbf7260c43e0f873c498202581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafcf95a38c780a4ad5ba14c8ac9e522bb"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gafcf95a38c780a4ad5ba14c8ac9e522bb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00222.html#gafcf95a38c780a4ad5ba14c8ac9e522bb">polar</a> (tvec3&lt; T, P &gt; const &amp;euclidean)</td></tr>
<tr class="separator:gafcf95a38c780a4ad5ba14c8ac9e522bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga3005cb0d839d546c616becfa6602c607"><td class="memItemLeft" align="right" valign="top">typedef detail::uint8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00222.html#ga3005cb0d839d546c616becfa6602c607">byte</a></td></tr>
<tr class="separator:ga3005cb0d839d546c616becfa6602c607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga86e46fff9f80ae33893d8d697f2ca98a"><td class="memItemLeft" align="right" valign="top">typedef detail::uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00222.html#ga86e46fff9f80ae33893d8d697f2ca98a">dword</a></td></tr>
<tr class="separator:ga86e46fff9f80ae33893d8d697f2ca98a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4021754ffb8e5ef14c75802b15657714"><td class="memItemLeft" align="right" valign="top">typedef detail::uint64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00222.html#ga4021754ffb8e5ef14c75802b15657714">qword</a></td></tr>
<tr class="separator:ga4021754ffb8e5ef14c75802b15657714"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga16e9fea0ef1e6c4ef472d3d1731c49a5"><td class="memItemLeft" align="right" valign="top">typedef detail::uint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00222.html#ga16e9fea0ef1e6c4ef472d3d1731c49a5">word</a></td></tr>
<tr class="separator:ga16e9fea0ef1e6c4ef472d3d1731c49a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Conversion from Euclidean space to polar space and revert. </p>
<p>&lt;<a class="el" href="a00091.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/polar_coordinates.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga45ece1fbf7260c43e0f873c498202581"></a>
<p>Projection of a vector to other one. </p>
<p>&lt;<a class="el" href="a00091.html" title="GLM_GTX_raw_data ">glm/gtx/raw_data.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga3005cb0d839d546c616becfa6602c607"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tvec3&lt;T, P&gt; glm::euclidean </td>
<td>(</td>
<td class="paramtype">tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>polar</em></td><td>)</td>
<td></td>
<td class="memname">typedef detail::uint8 byte</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert Polar to Euclidean coordinates. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00222.html" title="Conversion from Euclidean space to polar space and revert. ">GLM_GTX_polar_coordinates</a> </dd></dl>
<p>Type for byte numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00091_source.html#l00030">30</a> of file <a class="el" href="a00091_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gafcf95a38c780a4ad5ba14c8ac9e522bb"></a>
<a class="anchor" id="ga86e46fff9f80ae33893d8d697f2ca98a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tvec3&lt;T, P&gt; glm::polar </td>
<td>(</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>euclidean</em></td><td>)</td>
<td></td>
<td class="memname">typedef detail::uint32 dword</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert Euclidean to Polar coordinates, x is the xz distance, y, the latitude and z the longitude. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00222.html" title="Conversion from Euclidean space to polar space and revert. ">GLM_GTX_polar_coordinates</a> </dd></dl>
<p>Type for dword numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00091_source.html#l00038">38</a> of file <a class="el" href="a00091_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga4021754ffb8e5ef14c75802b15657714"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::uint64 qword</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for qword numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00091_source.html#l00042">42</a> of file <a class="el" href="a00091_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga16e9fea0ef1e6c4ef472d3d1731c49a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::uint16 word</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for word numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00091_source.html#l00034">34</a> of file <a class="el" href="a00091_source.html">raw_data.hpp</a>.</p>
</div>
</div>