Updated API documentation
This commit is contained in:
Christophe Riccio
@@ -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_vector_query</title>
|
||||
<title>0.9.9 API documenation: GLM_GTX_string_cast</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>
|
||||
@@ -78,233 +78,41 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_vector_query<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_string_cast<div class="ingroups"><a class="el" href="a00154.html">Experimental extensions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Include <<a class="el" href="a00132.html" title="GLM_GTX_vector_query ">glm/gtx/vector_query.hpp</a>> to use the features of this extension.
|
||||
<p>Include <<a class="el" href="a00097.html" title="GLM_GTX_string_cast ">glm/gtx/string_cast.hpp</a>> 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="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#ga13da4a787a2ff70e95d561fb19ff91b4">areCollinear</a> (vec< L, T, Q > const &v0, vec< L, T, Q > const &v1, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#gac7b95b3f798e3c293262b2bdaad47c57">areOrthogonal</a> (vec< L, T, Q > const &v0, vec< L, T, Q > const &v1, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:gac7b95b3f798e3c293262b2bdaad47c57"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#ga1b091c3d7f9ee3b0708311c001c293e3">areOrthonormal</a> (vec< L, T, Q > const &v0, vec< L, T, Q > const &v1, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, bool, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#gaf6ec1688eab7442fe96fe4941d5d4e76">isCompNull</a> (vec< L, T, Q > const &v, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:gac3c974f459fd75453134fad7ae89a39e"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gac3c974f459fd75453134fad7ae89a39e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#gac3c974f459fd75453134fad7ae89a39e">isNormalized</a> (vec< L, T, Q > const &v, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:gac3c974f459fd75453134fad7ae89a39e"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#gab4a3637dbcb4bb42dc55caea7a1e0495">isNull</a> (vec< L, T, Q > const &v, T const &epsilon)</td></tr>
|
||||
<tr class="memdesc:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:ga8f0dced1fd45e67e2d77e80ab93c7af5"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga8f0dced1fd45e67e2d77e80ab93c7af5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL std::string </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00227.html#ga8f0dced1fd45e67e2d77e80ab93c7af5">to_string</a> (genType const &x)</td></tr>
|
||||
<tr class="memdesc:ga8f0dced1fd45e67e2d77e80ab93c7af5"><td class="mdescLeft"> </td><td class="mdescRight">Create a string from a GLM vector or matrix typed variable. <a href="a00227.html#ga8f0dced1fd45e67e2d77e80ab93c7af5">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga8f0dced1fd45e67e2d77e80ab93c7af5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Include <<a class="el" href="a00132.html" title="GLM_GTX_vector_query ">glm/gtx/vector_query.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Query informations of vector types </p>
|
||||
<p>Include <<a class="el" href="a00097.html" title="GLM_GTX_string_cast ">glm/gtx/string_cast.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Setup strings for GLM type values</p>
|
||||
<p>This extension is not supported with CUDA </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga13da4a787a2ff70e95d561fb19ff91b4"></a>
|
||||
<a class="anchor" id="ga8f0dced1fd45e67e2d77e80ab93c7af5"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL bool glm::areCollinear </td>
|
||||
<td class="memname">GLM_FUNC_DECL std::string glm::to_string </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v0</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<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="gac7b95b3f798e3c293262b2bdaad47c57"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL bool glm::areOrthogonal </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v0</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<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="ga1b091c3d7f9ee3b0708311c001c293e3"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL bool glm::areOrthonormal </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v0</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<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="gaf6ec1688eab7442fe96fe4941d5d4e76"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vec<L, bool, Q> glm::isCompNull </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vec< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<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>
|
||||
|
||||
</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< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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< L, T, Q > const & </td>
|
||||
<td class="paramname"><em>v</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>epsilon</em> </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>
|
||||
<p>Create a string from a GLM vector or matrix typed variable. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00227.html" title="Include <glm/gtx/string_cast.hpp> to use the features of this extension. ">GLM_GTX_string_cast</a> extension. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user