mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API doc

Browse Source
This commit is contained in:
Christophe Riccio
2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 deletions
Download Patch File Download Diff File Expand all files Collapse all files

224
doc/api/a00227.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_vector_query</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>
@@ -75,99 +75,235 @@ 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="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_vector_query<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Projection of a vector to other one.
<p>Include &lt;<a class="el" href="a00132.html" title="GLM_GTX_vector_query ">glm/gtx/vector_query.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="a00227.html#ga3005cb0d839d546c616becfa6602c607">byte</a></td></tr>
<tr class="memdesc:ga3005cb0d839d546c616becfa6602c607"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for byte numbers. <a href="a00227.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="a00227.html#ga86e46fff9f80ae33893d8d697f2ca98a">dword</a></td></tr>
<tr class="memdesc:ga86e46fff9f80ae33893d8d697f2ca98a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for dword numbers. <a href="a00227.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="a00227.html#ga4021754ffb8e5ef14c75802b15657714">qword</a></td></tr>
<tr class="memdesc:ga4021754ffb8e5ef14c75802b15657714"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for qword numbers. <a href="a00227.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="a00227.html#ga16e9fea0ef1e6c4ef472d3d1731c49a5">word</a></td></tr>
<tr class="memdesc:ga16e9fea0ef1e6c4ef472d3d1731c49a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for word numbers. <a href="a00227.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:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#ga13da4a787a2ff70e95d561fb19ff91b4">areCollinear</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="memdesc:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are collinears. <a href="a00227.html#ga13da4a787a2ff70e95d561fb19ff91b4">More...</a><br /></td></tr>
<tr class="separator:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#gac7b95b3f798e3c293262b2bdaad47c57">areOrthogonal</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="memdesc:gac7b95b3f798e3c293262b2bdaad47c57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are orthogonals. <a href="a00227.html#gac7b95b3f798e3c293262b2bdaad47c57">More...</a><br /></td></tr>
<tr class="separator:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#ga1b091c3d7f9ee3b0708311c001c293e3">areOrthonormal</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
<tr class="memdesc:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are orthonormal. <a href="a00227.html#ga1b091c3d7f9ee3b0708311c001c293e3">More...</a><br /></td></tr>
<tr class="separator:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#gaf6ec1688eab7442fe96fe4941d5d4e76">isCompNull</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="memdesc:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a each component of a vector is null. <a href="a00227.html#gaf6ec1688eab7442fe96fe4941d5d4e76">More...</a><br /></td></tr>
<tr class="separator:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3c974f459fd75453134fad7ae89a39e"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gac3c974f459fd75453134fad7ae89a39e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#gac3c974f459fd75453134fad7ae89a39e">isNormalized</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="memdesc:gac3c974f459fd75453134fad7ae89a39e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a vector is normalized. <a href="a00227.html#gac3c974f459fd75453134fad7ae89a39e">More...</a><br /></td></tr>
<tr class="separator:gac3c974f459fd75453134fad7ae89a39e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#gab4a3637dbcb4bb42dc55caea7a1e0495">isNull</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
<tr class="memdesc:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a vector is null. <a href="a00227.html#gab4a3637dbcb4bb42dc55caea7a1e0495">More...</a><br /></td></tr>
<tr class="separator:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Projection of a vector to other one. </p>
<p>&lt;<a class="el" href="a00095.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>
<p>Include &lt;<a class="el" href="a00132.html" title="GLM_GTX_vector_query ">glm/gtx/vector_query.hpp</a>&gt; to use the features of this extension. </p>
<p>Query informations of vector types </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga13da4a787a2ff70e95d561fb19ff91b4"></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 bool glm::areCollinear </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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="a00095_source.html#l00034">34</a> of file <a class="el" href="a00095_source.html">raw_data.hpp</a>.</p>
<p>Check whether two vectors are collinears. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00227.html" title="Include <glm/gtx/vector_query.hpp> to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="ga86e46fff9f80ae33893d8d697f2ca98a"></a>
<a class="anchor" id="gac7b95b3f798e3c293262b2bdaad47c57"></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 bool glm::areOrthogonal </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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="a00095_source.html#l00042">42</a> of file <a class="el" href="a00095_source.html">raw_data.hpp</a>.</p>
<p>Check whether two vectors are orthogonals. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00227.html" title="Include <glm/gtx/vector_query.hpp> to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4021754ffb8e5ef14c75802b15657714"></a>
<a class="anchor" id="ga1b091c3d7f9ee3b0708311c001c293e3"></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 bool glm::areOrthonormal </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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="a00095_source.html#l00046">46</a> of file <a class="el" href="a00095_source.html">raw_data.hpp</a>.</p>
<p>Check whether two vectors are orthonormal. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00227.html" title="Include <glm/gtx/vector_query.hpp> to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="ga16e9fea0ef1e6c4ef472d3d1731c49a5"></a>
<a class="anchor" id="gaf6ec1688eab7442fe96fe4941d5d4e76"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef detail::uint16 word</td>
<td class="memname">GLM_FUNC_DECL vec&lt;L, bool, Q&gt; glm::isCompNull </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for word numbers. </p>
<p>From GLM_GTX_raw_data extension. </p>
<p>Check whether a each component of a vector is null. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00227.html" title="Include <glm/gtx/vector_query.hpp> to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
<p>Definition at line <a class="el" href="a00095_source.html#l00038">38</a> of file <a class="el" href="a00095_source.html">raw_data.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="gac3c974f459fd75453134fad7ae89a39e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::isNormalized </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a vector is normalized. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00227.html" title="Include <glm/gtx/vector_query.hpp> to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>
<a class="anchor" id="gab4a3637dbcb4bb42dc55caea7a1e0495"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::isNull </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>epsilon</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a vector is null. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00227.html" title="Include <glm/gtx/vector_query.hpp> to use the features of this extension. ">GLM_GTX_vector_query</a> extensions. </dd></dl>
</div>
</div>