mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

101
doc/api/a00214.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.9 API documenation: GLM_GTX_raw_data</title>
<title>0.9.9 API documenation: GLM_GTX_optimum_pow</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>
@@ -76,99 +76,88 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_raw_data<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
<div class="title">GLM_GTX_optimum_pow<div class="ingroups"><a class="el" href="a00154.html">Experimental extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Include &lt;<a class="el" href="a00087.html" title="GLM_GTX_raw_data ">glm/gtx/raw_data.hpp</a>&gt; to use the features of this extension.
<p>Include &lt;<a class="el" href="a00075.html" title="GLM_GTX_optimum_pow ">glm/gtx/optimum_pow.hpp</a>&gt; to use the features of this extension.
<a href="#details">More...</a></p>
<table class="memberdecls">
<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="a00214.html#ga3005cb0d839d546c616becfa6602c607">byte</a></td></tr>
<tr class="memdesc:ga3005cb0d839d546c616becfa6602c607"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for byte numbers. <a href="a00214.html#ga3005cb0d839d546c616becfa6602c607">More...</a><br /></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="a00214.html#ga86e46fff9f80ae33893d8d697f2ca98a">dword</a></td></tr>
<tr class="memdesc:ga86e46fff9f80ae33893d8d697f2ca98a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for dword numbers. <a href="a00214.html#ga86e46fff9f80ae33893d8d697f2ca98a">More...</a><br /></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="a00214.html#ga4021754ffb8e5ef14c75802b15657714">qword</a></td></tr>
<tr class="memdesc:ga4021754ffb8e5ef14c75802b15657714"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for qword numbers. <a href="a00214.html#ga4021754ffb8e5ef14c75802b15657714">More...</a><br /></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="a00214.html#ga16e9fea0ef1e6c4ef472d3d1731c49a5">word</a></td></tr>
<tr class="memdesc:ga16e9fea0ef1e6c4ef472d3d1731c49a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for word numbers. <a href="a00214.html#ga16e9fea0ef1e6c4ef472d3d1731c49a5">More...</a><br /></td></tr>
<tr class="separator:ga16e9fea0ef1e6c4ef472d3d1731c49a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga19aaff3213bf23bdec3ef124ace237e9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga19aaff3213bf23bdec3ef124ace237e9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga19aaff3213bf23bdec3ef124ace237e9">pow2</a> (genType const &amp;x)</td></tr>
<tr class="memdesc:ga19aaff3213bf23bdec3ef124ace237e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns x raised to the power of 2. <a href="a00214.html#ga19aaff3213bf23bdec3ef124ace237e9">More...</a><br /></td></tr>
<tr class="separator:ga19aaff3213bf23bdec3ef124ace237e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga35689d03cd434d6ea819f1942d3bf82e"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga35689d03cd434d6ea819f1942d3bf82e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga35689d03cd434d6ea819f1942d3bf82e">pow3</a> (genType const &amp;x)</td></tr>
<tr class="memdesc:ga35689d03cd434d6ea819f1942d3bf82e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns x raised to the power of 3. <a href="a00214.html#ga35689d03cd434d6ea819f1942d3bf82e">More...</a><br /></td></tr>
<tr class="separator:ga35689d03cd434d6ea819f1942d3bf82e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacef0968763026e180e53e735007dbf5a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gacef0968763026e180e53e735007dbf5a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gacef0968763026e180e53e735007dbf5a">pow4</a> (genType const &amp;x)</td></tr>
<tr class="memdesc:gacef0968763026e180e53e735007dbf5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns x raised to the power of 4. <a href="a00214.html#gacef0968763026e180e53e735007dbf5a">More...</a><br /></td></tr>
<tr class="separator:gacef0968763026e180e53e735007dbf5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Include &lt;<a class="el" href="a00087.html" title="GLM_GTX_raw_data ">glm/gtx/raw_data.hpp</a>&gt; to use the features of this extension. </p>
<p>Projection of a vector to other one </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga3005cb0d839d546c616becfa6602c607"></a>
<p>Include &lt;<a class="el" href="a00075.html" title="GLM_GTX_optimum_pow ">glm/gtx/optimum_pow.hpp</a>&gt; to use the features of this extension. </p>
<p>Integer exponentiation of power functions. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga19aaff3213bf23bdec3ef124ace237e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::uint8 byte</td>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow2 </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for byte numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00087_source.html#l00034">34</a> of file <a class="el" href="a00087_source.html">raw_data.hpp</a>.</p>
<p>Returns x raised to the power of 2. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00214.html" title="Include <glm/gtx/optimum_pow.hpp> to use the features of this extension. ">GLM_GTX_optimum_pow</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga86e46fff9f80ae33893d8d697f2ca98a"></a>
<a class="anchor" id="ga35689d03cd434d6ea819f1942d3bf82e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::uint32 dword</td>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow3 </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for dword numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Definition at line <a class="el" href="a00087_source.html#l00042">42</a> of file <a class="el" href="a00087_source.html">raw_data.hpp</a>.</p>
<p>Returns x raised to the power of 3. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00214.html" title="Include <glm/gtx/optimum_pow.hpp> to use the features of this extension. ">GLM_GTX_optimum_pow</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4021754ffb8e5ef14c75802b15657714"></a>
<a class="anchor" id="gacef0968763026e180e53e735007dbf5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::uint64 qword</td>
<td class="memname">GLM_FUNC_DECL genType glm::gtx::pow4 </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></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="a00087_source.html#l00046">46</a> of file <a class="el" href="a00087_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="a00087_source.html#l00038">38</a> of file <a class="el" href="a00087_source.html">raw_data.hpp</a>.</p>
<p>Returns x raised to the power of 4. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00214.html" title="Include <glm/gtx/optimum_pow.hpp> to use the features of this extension. ">GLM_GTX_optimum_pow</a> </dd></dl>
</div>
</div>