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

86
doc/api/a00084_source.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: number_precision.hpp Source File</title>
<title>0.9.8: polar_coordinates.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,64 +46,36 @@
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">number_precision.hpp</div> </div>
<div class="title">polar_coordinates.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00084.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="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#include &quot;../gtc/type_precision.hpp&quot;</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_number_precision extension included&quot;)</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a>{</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword">namespace </span>gtx</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;{</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">// Unsigned int vector types </span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="a00218.html#ga5853fe457f4c8a6bc09343d0e9833980"> 63</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#gaecc7082561fc9028b844b6cf3d305d36">u8</a> <a class="code" href="a00218.html#ga5853fe457f4c8a6bc09343d0e9833980">u8vec1</a>; </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="a00218.html#ga52cc069a92e126c3a8dcde93424d2ef0"> 64</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#gaa2d7acc0adb536fab71fe261232a40ff">u16</a> <a class="code" href="a00218.html#ga52cc069a92e126c3a8dcde93424d2ef0">u16vec1</a>; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="a00218.html#ga9bbc1e14aea65cba5e2dcfef6a67d9f3"> 65</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#ga8165913e068444f7842302d40ba897b9">u32</a> <a class="code" href="a00218.html#ga9bbc1e14aea65cba5e2dcfef6a67d9f3">u32vec1</a>; </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="a00218.html#ga818de170e2584ab037130f2881925974"> 66</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#gaf3f312156984c365e9f65620354da70b">u64</a> <a class="code" href="a00218.html#ga818de170e2584ab037130f2881925974">u64vec1</a>; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// Float vector types </span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="a00218.html#ga07f8d7348eb7ae059a84c118fdfeb943"> 71</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#gabe6a542dd6c1d5ffd847f1b9b4c9c9b7">f32</a> <a class="code" href="a00218.html#ga07f8d7348eb7ae059a84c118fdfeb943">f32vec1</a>; </div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="a00218.html#gae5987a61b8c03d5c432a9e62f0b3efe1"> 72</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#ga1d794d240091678f602e8de225b8d8c9">f64</a> <a class="code" href="a00218.html#gae5987a61b8c03d5c432a9e62f0b3efe1">f64vec1</a>; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">// Float matrix types </span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="a00218.html#ga145ad477a2a3e152855511c3b52469a6"> 77</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#gabe6a542dd6c1d5ffd847f1b9b4c9c9b7">f32</a> <a class="code" href="a00218.html#ga145ad477a2a3e152855511c3b52469a6">f32mat1</a>; </div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="a00218.html#gac88c6a4dbfc380aa26e3adbbade36348"> 78</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#gabe6a542dd6c1d5ffd847f1b9b4c9c9b7">f32</a> <a class="code" href="a00218.html#gac88c6a4dbfc380aa26e3adbbade36348">f32mat1x1</a>; </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="a00218.html#ga59bfa589419b5265d01314fcecd33435"> 79</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#ga1d794d240091678f602e8de225b8d8c9">f64</a> <a class="code" href="a00218.html#ga59bfa589419b5265d01314fcecd33435">f64mat1</a>; </div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="a00218.html#ga448eeb08d0b7d8c43a8b292c981955fd"> 80</a></span>&#160; <span class="keyword">typedef</span> <a class="code" href="a00181.html#ga1d794d240091678f602e8de225b8d8c9">f64</a> <a class="code" href="a00218.html#ga448eeb08d0b7d8c43a8b292c981955fd">f64mat1x1</a>; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;}<span class="comment">//namespace gtx</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#include &quot;number_precision.inl&quot;</span></div>
<div class="ttc" id="a00181_html_ga8165913e068444f7842302d40ba897b9"><div class="ttname"><a href="a00181.html#ga8165913e068444f7842302d40ba897b9">glm::u32</a></div><div class="ttdeci">detail::uint32 u32</div><div class="ttdoc">32 bit unsigned integer type. </div><div class="ttdef"><b>Definition:</b> <a href="a00038_source.html#l00931">fwd.hpp:931</a></div></div>
<div class="ttc" id="a00218_html_gac88c6a4dbfc380aa26e3adbbade36348"><div class="ttname"><a href="a00218.html#gac88c6a4dbfc380aa26e3adbbade36348">glm::gtx::f32mat1x1</a></div><div class="ttdeci">f32 f32mat1x1</div><div class="ttdoc">Single-precision floating-point scalar. (from GLM_GTX_number_precision extension) ...</div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00078">number_precision.hpp:78</a></div></div>
<div class="ttc" id="a00181_html_gaf3f312156984c365e9f65620354da70b"><div class="ttname"><a href="a00181.html#gaf3f312156984c365e9f65620354da70b">glm::u64</a></div><div class="ttdeci">detail::uint64 u64</div><div class="ttdoc">64 bit unsigned integer type. </div><div class="ttdef"><b>Definition:</b> <a href="a00038_source.html#l00935">fwd.hpp:935</a></div></div>
<div class="ttc" id="a00218_html_ga5853fe457f4c8a6bc09343d0e9833980"><div class="ttname"><a href="a00218.html#ga5853fe457f4c8a6bc09343d0e9833980">glm::gtx::u8vec1</a></div><div class="ttdeci">u8 u8vec1</div><div class="ttdoc">8bit unsigned integer scalar. (from GLM_GTX_number_precision extension) </div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00063">number_precision.hpp:63</a></div></div>
<div class="ttc" id="a00218_html_ga145ad477a2a3e152855511c3b52469a6"><div class="ttname"><a href="a00218.html#ga145ad477a2a3e152855511c3b52469a6">glm::gtx::f32mat1</a></div><div class="ttdeci">f32 f32mat1</div><div class="ttdoc">Single-precision floating-point scalar. (from GLM_GTX_number_precision extension) ...</div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00077">number_precision.hpp:77</a></div></div>
<div class="ttc" id="a00218_html_ga07f8d7348eb7ae059a84c118fdfeb943"><div class="ttname"><a href="a00218.html#ga07f8d7348eb7ae059a84c118fdfeb943">glm::gtx::f32vec1</a></div><div class="ttdeci">f32 f32vec1</div><div class="ttdoc">Single-precision floating-point scalar. (from GLM_GTX_number_precision extension) ...</div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00071">number_precision.hpp:71</a></div></div>
<div class="ttc" id="a00181_html_gaa2d7acc0adb536fab71fe261232a40ff"><div class="ttname"><a href="a00181.html#gaa2d7acc0adb536fab71fe261232a40ff">glm::u16</a></div><div class="ttdeci">detail::uint16 u16</div><div class="ttdoc">16 bit unsigned integer type. </div><div class="ttdef"><b>Definition:</b> <a href="a00038_source.html#l00927">fwd.hpp:927</a></div></div>
<div class="ttc" id="a00181_html_ga1d794d240091678f602e8de225b8d8c9"><div class="ttname"><a href="a00181.html#ga1d794d240091678f602e8de225b8d8c9">glm::f64</a></div><div class="ttdeci">highp_float64_t f64</div><div class="ttdoc">Default 64 bit double-precision floating-point scalar. </div><div class="ttdef"><b>Definition:</b> <a href="a00038_source.html#l01538">fwd.hpp:1538</a></div></div>
<div class="ttc" id="a00218_html_gae5987a61b8c03d5c432a9e62f0b3efe1"><div class="ttname"><a href="a00218.html#gae5987a61b8c03d5c432a9e62f0b3efe1">glm::gtx::f64vec1</a></div><div class="ttdeci">f64 f64vec1</div><div class="ttdoc">Single-precision floating-point scalar. (from GLM_GTX_number_precision extension) ...</div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00072">number_precision.hpp:72</a></div></div>
<div class="ttc" id="a00218_html_ga448eeb08d0b7d8c43a8b292c981955fd"><div class="ttname"><a href="a00218.html#ga448eeb08d0b7d8c43a8b292c981955fd">glm::gtx::f64mat1x1</a></div><div class="ttdeci">f64 f64mat1x1</div><div class="ttdoc">Double-precision floating-point scalar. (from GLM_GTX_number_precision extension) ...</div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00080">number_precision.hpp:80</a></div></div>
<div class="ttc" id="a00181_html_gabe6a542dd6c1d5ffd847f1b9b4c9c9b7"><div class="ttname"><a href="a00181.html#gabe6a542dd6c1d5ffd847f1b9b4c9c9b7">glm::f32</a></div><div class="ttdeci">highp_float32_t f32</div><div class="ttdoc">Default 32 bit single-precision floating-point scalar. </div><div class="ttdef"><b>Definition:</b> <a href="a00038_source.html#l01534">fwd.hpp:1534</a></div></div>
<div class="ttc" id="a00181_html_gaecc7082561fc9028b844b6cf3d305d36"><div class="ttname"><a href="a00181.html#gaecc7082561fc9028b844b6cf3d305d36">glm::u8</a></div><div class="ttdeci">detail::uint8 u8</div><div class="ttdoc">8 bit unsigned integer type. </div><div class="ttdef"><b>Definition:</b> <a href="a00038_source.html#l00923">fwd.hpp:923</a></div></div>
<div class="ttc" id="a00218_html_ga52cc069a92e126c3a8dcde93424d2ef0"><div class="ttname"><a href="a00218.html#ga52cc069a92e126c3a8dcde93424d2ef0">glm::gtx::u16vec1</a></div><div class="ttdeci">u16 u16vec1</div><div class="ttdoc">16bit unsigned integer scalar. (from GLM_GTX_number_precision extension) </div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00064">number_precision.hpp:64</a></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="a00218_html_ga59bfa589419b5265d01314fcecd33435"><div class="ttname"><a href="a00218.html#ga59bfa589419b5265d01314fcecd33435">glm::gtx::f64mat1</a></div><div class="ttdeci">f64 f64mat1</div><div class="ttdoc">Double-precision floating-point scalar. (from GLM_GTX_number_precision extension) ...</div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00079">number_precision.hpp:79</a></div></div>
<div class="ttc" id="a00218_html_ga818de170e2584ab037130f2881925974"><div class="ttname"><a href="a00218.html#ga818de170e2584ab037130f2881925974">glm::gtx::u64vec1</a></div><div class="ttdeci">u64 u64vec1</div><div class="ttdoc">64bit unsigned integer scalar. (from GLM_GTX_number_precision extension) </div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00066">number_precision.hpp:66</a></div></div>
<div class="ttc" id="a00218_html_ga9bbc1e14aea65cba5e2dcfef6a67d9f3"><div class="ttname"><a href="a00218.html#ga9bbc1e14aea65cba5e2dcfef6a67d9f3">glm::gtx::u32vec1</a></div><div class="ttdeci">u32 u32vec1</div><div class="ttdoc">32bit unsigned integer scalar. (from GLM_GTX_number_precision extension) </div><div class="ttdef"><b>Definition:</b> <a href="a00084_source.html#l00065">number_precision.hpp:65</a></div></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">// Dependency:</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_polar_coordinates extension included&quot;)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00141.html">glm</a></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00218.html#gafcf95a38c780a4ad5ba14c8ac9e522bb">polar</a>(</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00218.html#ga45ece1fbf7260c43e0f873c498202581">euclidean</a>);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00218.html#ga45ece1fbf7260c43e0f873c498202581">euclidean</a>(</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00218.html#gafcf95a38c780a4ad5ba14c8ac9e522bb">polar</a>);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;}<span class="comment">//namespace glm</span></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="preprocessor">#include &quot;polar_coordinates.inl&quot;</span></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="a00218_html_gafcf95a38c780a4ad5ba14c8ac9e522bb"><div class="ttname"><a href="a00218.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="ttc" id="a00218_html_ga45ece1fbf7260c43e0f873c498202581"><div class="ttname"><a href="a00218.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><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>