Updated API documentation

This commit is contained in:
Christophe Riccio
2018-05-08 13:51:58 +02:00
parent 4d4dbcade6
commit c3a41b0ef8
470 changed files with 72126 additions and 68787 deletions

View File

@@ -103,37 +103,37 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_std_based_type extension included&quot;)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00135.html">glm</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00138.html">glm</a></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="a00219.html#gaeb877ac8f9a3703961736c1c5072cf68"> 35</a></span>&#160; <span class="keyword">typedef</span> vec&lt;1, std::size_t, defaultp&gt; <a class="code" href="a00219.html#gaeb877ac8f9a3703961736c1c5072cf68">size1</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="a00226.html#gaeb877ac8f9a3703961736c1c5072cf68"> 35</a></span>&#160; <span class="keyword">typedef</span> vec&lt;1, std::size_t, defaultp&gt; <a class="code" href="a00226.html#gaeb877ac8f9a3703961736c1c5072cf68">size1</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="a00219.html#ga1bfe8c4975ff282bce41be2bacd524fe"> 39</a></span>&#160; <span class="keyword">typedef</span> vec&lt;2, std::size_t, defaultp&gt; <a class="code" href="a00219.html#ga1bfe8c4975ff282bce41be2bacd524fe">size2</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="a00226.html#ga1bfe8c4975ff282bce41be2bacd524fe"> 39</a></span>&#160; <span class="keyword">typedef</span> vec&lt;2, std::size_t, defaultp&gt; <a class="code" href="a00226.html#ga1bfe8c4975ff282bce41be2bacd524fe">size2</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="a00219.html#gae1c72956d0359b0db332c6c8774d3b04"> 43</a></span>&#160; <span class="keyword">typedef</span> vec&lt;3, std::size_t, defaultp&gt; <a class="code" href="a00219.html#gae1c72956d0359b0db332c6c8774d3b04">size3</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="a00226.html#gae1c72956d0359b0db332c6c8774d3b04"> 43</a></span>&#160; <span class="keyword">typedef</span> vec&lt;3, std::size_t, defaultp&gt; <a class="code" href="a00226.html#gae1c72956d0359b0db332c6c8774d3b04">size3</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="a00219.html#ga3a19dde617beaf8ce3cfc2ac5064e9aa"> 47</a></span>&#160; <span class="keyword">typedef</span> vec&lt;4, std::size_t, defaultp&gt; <a class="code" href="a00219.html#ga3a19dde617beaf8ce3cfc2ac5064e9aa">size4</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="a00226.html#ga3a19dde617beaf8ce3cfc2ac5064e9aa"> 47</a></span>&#160; <span class="keyword">typedef</span> vec&lt;4, std::size_t, defaultp&gt; <a class="code" href="a00226.html#ga3a19dde617beaf8ce3cfc2ac5064e9aa">size4</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="a00219.html#gaaf6accc57f5aa50447ba7310ce3f0d6f"> 51</a></span>&#160; <span class="keyword">typedef</span> vec&lt;1, std::size_t, defaultp&gt; <a class="code" href="a00219.html#gaaf6accc57f5aa50447ba7310ce3f0d6f">size1_t</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="a00226.html#gaaf6accc57f5aa50447ba7310ce3f0d6f"> 51</a></span>&#160; <span class="keyword">typedef</span> vec&lt;1, std::size_t, defaultp&gt; <a class="code" href="a00226.html#gaaf6accc57f5aa50447ba7310ce3f0d6f">size1_t</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"><a class="line" href="a00219.html#ga5976c25657d4e2b5f73f39364c3845d6"> 55</a></span>&#160; <span class="keyword">typedef</span> vec&lt;2, std::size_t, defaultp&gt; <a class="code" href="a00219.html#ga5976c25657d4e2b5f73f39364c3845d6">size2_t</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="a00226.html#ga5976c25657d4e2b5f73f39364c3845d6"> 55</a></span>&#160; <span class="keyword">typedef</span> vec&lt;2, std::size_t, defaultp&gt; <a class="code" href="a00226.html#ga5976c25657d4e2b5f73f39364c3845d6">size2_t</a>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="a00219.html#gaf2654983c60d641fd3808e65a8dfad8d"> 59</a></span>&#160; <span class="keyword">typedef</span> vec&lt;3, std::size_t, defaultp&gt; <a class="code" href="a00219.html#gaf2654983c60d641fd3808e65a8dfad8d">size3_t</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="a00226.html#gaf2654983c60d641fd3808e65a8dfad8d"> 59</a></span>&#160; <span class="keyword">typedef</span> vec&lt;3, std::size_t, defaultp&gt; <a class="code" href="a00226.html#gaf2654983c60d641fd3808e65a8dfad8d">size3_t</a>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="a00219.html#gaa423efcea63675a2df26990dbcb58656"> 63</a></span>&#160; <span class="keyword">typedef</span> vec&lt;4, std::size_t, defaultp&gt; <a class="code" href="a00219.html#gaa423efcea63675a2df26990dbcb58656">size4_t</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="a00226.html#gaa423efcea63675a2df26990dbcb58656"> 63</a></span>&#160; <span class="keyword">typedef</span> vec&lt;4, std::size_t, defaultp&gt; <a class="code" href="a00226.html#gaa423efcea63675a2df26990dbcb58656">size4_t</a>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor">#include &quot;std_based_type.inl&quot;</span></div>
<div class="ttc" id="a00219_html_gaf2654983c60d641fd3808e65a8dfad8d"><div class="ttname"><a href="a00219.html#gaf2654983c60d641fd3808e65a8dfad8d">glm::size3_t</a></div><div class="ttdeci">vec&lt; 3, std::size_t, defaultp &gt; size3_t</div><div class="ttdoc">Vector type based of three std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00059">std_based_type.hpp:59</a></div></div>
<div class="ttc" id="a00219_html_ga1bfe8c4975ff282bce41be2bacd524fe"><div class="ttname"><a href="a00219.html#ga1bfe8c4975ff282bce41be2bacd524fe">glm::size2</a></div><div class="ttdeci">vec&lt; 2, std::size_t, defaultp &gt; size2</div><div class="ttdoc">Vector type based of two std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00039">std_based_type.hpp:39</a></div></div>
<div class="ttc" id="a00135_html"><div class="ttname"><a href="a00135.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
<div class="ttc" id="a00219_html_gaa423efcea63675a2df26990dbcb58656"><div class="ttname"><a href="a00219.html#gaa423efcea63675a2df26990dbcb58656">glm::size4_t</a></div><div class="ttdeci">vec&lt; 4, std::size_t, defaultp &gt; size4_t</div><div class="ttdoc">Vector type based of four std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00063">std_based_type.hpp:63</a></div></div>
<div class="ttc" id="a00219_html_gaeb877ac8f9a3703961736c1c5072cf68"><div class="ttname"><a href="a00219.html#gaeb877ac8f9a3703961736c1c5072cf68">glm::size1</a></div><div class="ttdeci">vec&lt; 1, std::size_t, defaultp &gt; size1</div><div class="ttdoc">Vector type based of one std::size_t component. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00035">std_based_type.hpp:35</a></div></div>
<div class="ttc" id="a00219_html_ga5976c25657d4e2b5f73f39364c3845d6"><div class="ttname"><a href="a00219.html#ga5976c25657d4e2b5f73f39364c3845d6">glm::size2_t</a></div><div class="ttdeci">vec&lt; 2, std::size_t, defaultp &gt; size2_t</div><div class="ttdoc">Vector type based of two std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00055">std_based_type.hpp:55</a></div></div>
<div class="ttc" id="a00219_html_gae1c72956d0359b0db332c6c8774d3b04"><div class="ttname"><a href="a00219.html#gae1c72956d0359b0db332c6c8774d3b04">glm::size3</a></div><div class="ttdeci">vec&lt; 3, std::size_t, defaultp &gt; size3</div><div class="ttdoc">Vector type based of three std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00043">std_based_type.hpp:43</a></div></div>
<div class="ttc" id="a00219_html_ga3a19dde617beaf8ce3cfc2ac5064e9aa"><div class="ttname"><a href="a00219.html#ga3a19dde617beaf8ce3cfc2ac5064e9aa">glm::size4</a></div><div class="ttdeci">vec&lt; 4, std::size_t, defaultp &gt; size4</div><div class="ttdoc">Vector type based of four std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00047">std_based_type.hpp:47</a></div></div>
<div class="ttc" id="a00219_html_gaaf6accc57f5aa50447ba7310ce3f0d6f"><div class="ttname"><a href="a00219.html#gaaf6accc57f5aa50447ba7310ce3f0d6f">glm::size1_t</a></div><div class="ttdeci">vec&lt; 1, std::size_t, defaultp &gt; size1_t</div><div class="ttdoc">Vector type based of one std::size_t component. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00051">std_based_type.hpp:51</a></div></div>
<div class="ttc" id="a00226_html_ga5976c25657d4e2b5f73f39364c3845d6"><div class="ttname"><a href="a00226.html#ga5976c25657d4e2b5f73f39364c3845d6">glm::size2_t</a></div><div class="ttdeci">vec&lt; 2, std::size_t, defaultp &gt; size2_t</div><div class="ttdoc">Vector type based of two std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00055">std_based_type.hpp:55</a></div></div>
<div class="ttc" id="a00226_html_gaaf6accc57f5aa50447ba7310ce3f0d6f"><div class="ttname"><a href="a00226.html#gaaf6accc57f5aa50447ba7310ce3f0d6f">glm::size1_t</a></div><div class="ttdeci">vec&lt; 1, std::size_t, defaultp &gt; size1_t</div><div class="ttdoc">Vector type based of one std::size_t component. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00051">std_based_type.hpp:51</a></div></div>
<div class="ttc" id="a00226_html_gaeb877ac8f9a3703961736c1c5072cf68"><div class="ttname"><a href="a00226.html#gaeb877ac8f9a3703961736c1c5072cf68">glm::size1</a></div><div class="ttdeci">vec&lt; 1, std::size_t, defaultp &gt; size1</div><div class="ttdoc">Vector type based of one std::size_t component. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00035">std_based_type.hpp:35</a></div></div>
<div class="ttc" id="a00138_html"><div class="ttname"><a href="a00138.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
<div class="ttc" id="a00226_html_gaa423efcea63675a2df26990dbcb58656"><div class="ttname"><a href="a00226.html#gaa423efcea63675a2df26990dbcb58656">glm::size4_t</a></div><div class="ttdeci">vec&lt; 4, std::size_t, defaultp &gt; size4_t</div><div class="ttdoc">Vector type based of four std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00063">std_based_type.hpp:63</a></div></div>
<div class="ttc" id="a00226_html_gaf2654983c60d641fd3808e65a8dfad8d"><div class="ttname"><a href="a00226.html#gaf2654983c60d641fd3808e65a8dfad8d">glm::size3_t</a></div><div class="ttdeci">vec&lt; 3, std::size_t, defaultp &gt; size3_t</div><div class="ttdoc">Vector type based of three std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00059">std_based_type.hpp:59</a></div></div>
<div class="ttc" id="a00226_html_ga3a19dde617beaf8ce3cfc2ac5064e9aa"><div class="ttname"><a href="a00226.html#ga3a19dde617beaf8ce3cfc2ac5064e9aa">glm::size4</a></div><div class="ttdeci">vec&lt; 4, std::size_t, defaultp &gt; size4</div><div class="ttdoc">Vector type based of four std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00047">std_based_type.hpp:47</a></div></div>
<div class="ttc" id="a00226_html_ga1bfe8c4975ff282bce41be2bacd524fe"><div class="ttname"><a href="a00226.html#ga1bfe8c4975ff282bce41be2bacd524fe">glm::size2</a></div><div class="ttdeci">vec&lt; 2, std::size_t, defaultp &gt; size2</div><div class="ttdoc">Vector type based of two std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00039">std_based_type.hpp:39</a></div></div>
<div class="ttc" id="a00226_html_gae1c72956d0359b0db332c6c8774d3b04"><div class="ttname"><a href="a00226.html#gae1c72956d0359b0db332c6c8774d3b04">glm::size3</a></div><div class="ttdeci">vec&lt; 3, std::size_t, defaultp &gt; size3</div><div class="ttdoc">Vector type based of three std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00096_source.html#l00043">std_based_type.hpp:43</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>