Updated API documentation

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

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: polar_coordinates.hpp Source File</title>
<title>0.9.8: raw_data.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>
@@ -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>
@@ -46,36 +46,39 @@
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">polar_coordinates.hpp</div> </div>
<div class="title">raw_data.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00091.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// Dependencies</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;../detail/setup.hpp&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;../detail/type_int.hpp&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_raw_data extension included&quot;)</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00141.html">glm</a></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="a00222.html#ga3005cb0d839d546c616becfa6602c607"> 30</a></span>&#160; <span class="keyword">typedef</span> detail::uint8 <a class="code" href="a00222.html#ga3005cb0d839d546c616becfa6602c607">byte</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="a00222.html#ga16e9fea0ef1e6c4ef472d3d1731c49a5"> 34</a></span>&#160; <span class="keyword">typedef</span> detail::uint16 <a class="code" href="a00222.html#ga16e9fea0ef1e6c4ef472d3d1731c49a5">word</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="a00222.html#ga86e46fff9f80ae33893d8d697f2ca98a"> 38</a></span>&#160; <span class="keyword">typedef</span> detail::uint32 <a class="code" href="a00222.html#ga86e46fff9f80ae33893d8d697f2ca98a">dword</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="a00222.html#ga4021754ffb8e5ef14c75802b15657714"> 42</a></span>&#160; <span class="keyword">typedef</span> detail::uint64 <a class="code" href="a00222.html#ga4021754ffb8e5ef14c75802b15657714">qword</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}<span class="comment">// namespace glm</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_polar_coordinates extension included&quot;)</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;{</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00222.html#gafcf95a38c780a4ad5ba14c8ac9e522bb">polar</a>(</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00222.html#ga45ece1fbf7260c43e0f873c498202581">euclidean</a>);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00222.html#ga45ece1fbf7260c43e0f873c498202581">euclidean</a>(</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00222.html#gafcf95a38c780a4ad5ba14c8ac9e522bb">polar</a>);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#include &quot;polar_coordinates.inl&quot;</span></div>
<div class="ttc" id="a00222_html_ga45ece1fbf7260c43e0f873c498202581"><div class="ttname"><a href="a00222.html#ga45ece1fbf7260c43e0f873c498202581">glm::euclidean</a></div><div class="ttdeci">GLM_FUNC_DECL tvec3&lt; T, P &gt; euclidean(tvec2&lt; T, P &gt; const &amp;polar)</div><div class="ttdoc">Convert Polar to Euclidean coordinates. </div></div>
<div class="ttc" id="a00146_html"><div class="ttname"><a href="a00146.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00040">_noise.hpp:40</a></div></div>
<div class="ttc" id="a00222_html_gafcf95a38c780a4ad5ba14c8ac9e522bb"><div class="ttname"><a href="a00222.html#gafcf95a38c780a4ad5ba14c8ac9e522bb">glm::polar</a></div><div class="ttdeci">GLM_FUNC_DECL tvec3&lt; T, P &gt; polar(tvec3&lt; T, P &gt; const &amp;euclidean)</div><div class="ttdoc">Convert Euclidean to Polar coordinates, x is the xz distance, y, the latitude and z the longitude...</div></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &quot;raw_data.inl&quot;</span></div>
<div class="ttc" id="a00222_html_ga4021754ffb8e5ef14c75802b15657714"><div class="ttname"><a href="a00222.html#ga4021754ffb8e5ef14c75802b15657714">glm::qword</a></div><div class="ttdeci">detail::uint64 qword</div><div class="ttdoc">Type for qword numbers. </div><div class="ttdef"><b>Definition:</b> <a href="a00091_source.html#l00042">raw_data.hpp:42</a></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="a00222_html_ga3005cb0d839d546c616becfa6602c607"><div class="ttname"><a href="a00222.html#ga3005cb0d839d546c616becfa6602c607">glm::byte</a></div><div class="ttdeci">detail::uint8 byte</div><div class="ttdoc">Type for byte numbers. </div><div class="ttdef"><b>Definition:</b> <a href="a00091_source.html#l00030">raw_data.hpp:30</a></div></div>
<div class="ttc" id="a00222_html_ga16e9fea0ef1e6c4ef472d3d1731c49a5"><div class="ttname"><a href="a00222.html#ga16e9fea0ef1e6c4ef472d3d1731c49a5">glm::word</a></div><div class="ttdeci">detail::uint16 word</div><div class="ttdoc">Type for word numbers. </div><div class="ttdef"><b>Definition:</b> <a href="a00091_source.html#l00034">raw_data.hpp:34</a></div></div>
<div class="ttc" id="a00222_html_ga86e46fff9f80ae33893d8d697f2ca98a"><div class="ttname"><a href="a00222.html#ga86e46fff9f80ae33893d8d697f2ca98a">glm::dword</a></div><div class="ttdeci">detail::uint32 dword</div><div class="ttdoc">Type for dword numbers. </div><div class="ttdef"><b>Definition:</b> <a href="a00091_source.html#l00038">raw_data.hpp:38</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>