mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen API doc

Browse Source
This commit is contained in:
Christophe Riccio
2016-11-13 00:39:32 +01:00
parent 83d14ee411
commit d8ca117cb6
394 changed files with 48595 additions and 40958 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
doc/api/a00178.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.8: GLM_GTC_type_ptr</title>
<title>0.9.8 API documenation: GLM_GTC_type_ptr</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.8
<div id="projectname">0.9.8 API documenation
</div>
</td>
</tr>
@@ -39,77 +39,97 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTC_type_ptr<div class="ingroups"><a class="el" href="a00154.html">GTC Extensions (Stable)</a></div></div> </div>
<div class="title">GLM_GTC_type_ptr<div class="ingroups"><a class="el" href="a00153.html">GTC Extensions (Stable)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Handles the interaction between pointers and vector, matrix types.
<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:ga52a16e333fef7e33ca740779482a8693"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga52a16e333fef7e33ca740779482a8693"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat2x2&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga52a16e333fef7e33ca740779482a8693">make_mat2</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga52a16e333fef7e33ca740779482a8693"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#ga52a16e333fef7e33ca740779482a8693">More...</a><br /></td></tr>
<tr class="separator:ga52a16e333fef7e33ca740779482a8693"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadb29e510762e1042069cb28bf24ae990"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gadb29e510762e1042069cb28bf24ae990"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat2x2&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#gadb29e510762e1042069cb28bf24ae990">make_mat2x2</a> (T const *const ptr)</td></tr>
<tr class="memdesc:gadb29e510762e1042069cb28bf24ae990"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#gadb29e510762e1042069cb28bf24ae990">More...</a><br /></td></tr>
<tr class="separator:gadb29e510762e1042069cb28bf24ae990"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37988c6dd941f617cdfab86d54375fc1"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga37988c6dd941f617cdfab86d54375fc1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat2x3&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga37988c6dd941f617cdfab86d54375fc1">make_mat2x3</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga37988c6dd941f617cdfab86d54375fc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#ga37988c6dd941f617cdfab86d54375fc1">More...</a><br /></td></tr>
<tr class="separator:ga37988c6dd941f617cdfab86d54375fc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6dfb2ac10859b0cc8e3893ea84fa95b5"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga6dfb2ac10859b0cc8e3893ea84fa95b5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat2x4&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga6dfb2ac10859b0cc8e3893ea84fa95b5">make_mat2x4</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga6dfb2ac10859b0cc8e3893ea84fa95b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#ga6dfb2ac10859b0cc8e3893ea84fa95b5">More...</a><br /></td></tr>
<tr class="separator:ga6dfb2ac10859b0cc8e3893ea84fa95b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2bc10c519ffc8db9e24f325f23787ea"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gac2bc10c519ffc8db9e24f325f23787ea"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat3x3&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#gac2bc10c519ffc8db9e24f325f23787ea">make_mat3</a> (T const *const ptr)</td></tr>
<tr class="memdesc:gac2bc10c519ffc8db9e24f325f23787ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#gac2bc10c519ffc8db9e24f325f23787ea">More...</a><br /></td></tr>
<tr class="separator:gac2bc10c519ffc8db9e24f325f23787ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe1e5066608a66da7a94f802b57b4eed"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gabe1e5066608a66da7a94f802b57b4eed"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat3x2&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#gabe1e5066608a66da7a94f802b57b4eed">make_mat3x2</a> (T const *const ptr)</td></tr>
<tr class="memdesc:gabe1e5066608a66da7a94f802b57b4eed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#gabe1e5066608a66da7a94f802b57b4eed">More...</a><br /></td></tr>
<tr class="separator:gabe1e5066608a66da7a94f802b57b4eed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3cbe7adf857c867cee77eae4617abadd"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga3cbe7adf857c867cee77eae4617abadd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat3x3&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga3cbe7adf857c867cee77eae4617abadd">make_mat3x3</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga3cbe7adf857c867cee77eae4617abadd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#ga3cbe7adf857c867cee77eae4617abadd">More...</a><br /></td></tr>
<tr class="separator:ga3cbe7adf857c867cee77eae4617abadd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac083edd180ab4d4b817acc60c516209b"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gac083edd180ab4d4b817acc60c516209b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat3x4&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#gac083edd180ab4d4b817acc60c516209b">make_mat3x4</a> (T const *const ptr)</td></tr>
<tr class="memdesc:gac083edd180ab4d4b817acc60c516209b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#gac083edd180ab4d4b817acc60c516209b">More...</a><br /></td></tr>
<tr class="separator:gac083edd180ab4d4b817acc60c516209b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c6e6d457cb932e1ce683e4f690a6f60"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga2c6e6d457cb932e1ce683e4f690a6f60"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga2c6e6d457cb932e1ce683e4f690a6f60">make_mat4</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga2c6e6d457cb932e1ce683e4f690a6f60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#ga2c6e6d457cb932e1ce683e4f690a6f60">More...</a><br /></td></tr>
<tr class="separator:ga2c6e6d457cb932e1ce683e4f690a6f60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga967a5b934e67ff9a6d1d0d27a377a264"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga967a5b934e67ff9a6d1d0d27a377a264"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x2&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga967a5b934e67ff9a6d1d0d27a377a264">make_mat4x2</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga967a5b934e67ff9a6d1d0d27a377a264"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#ga967a5b934e67ff9a6d1d0d27a377a264">More...</a><br /></td></tr>
<tr class="separator:ga967a5b934e67ff9a6d1d0d27a377a264"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d42daced532b33cc672280e48670a51"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga4d42daced532b33cc672280e48670a51"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x3&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga4d42daced532b33cc672280e48670a51">make_mat4x3</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga4d42daced532b33cc672280e48670a51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#ga4d42daced532b33cc672280e48670a51">More...</a><br /></td></tr>
<tr class="separator:ga4d42daced532b33cc672280e48670a51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf605a5f5e2ff594e8d404b2855b09541"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaf605a5f5e2ff594e8d404b2855b09541"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#gaf605a5f5e2ff594e8d404b2855b09541">make_mat4x4</a> (T const *const ptr)</td></tr>
<tr class="memdesc:gaf605a5f5e2ff594e8d404b2855b09541"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a matrix from a pointer. <a href="a00178.html#gaf605a5f5e2ff594e8d404b2855b09541">More...</a><br /></td></tr>
<tr class="separator:gaf605a5f5e2ff594e8d404b2855b09541"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaadafb6600af2633e4c98cc64c72f5269"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaadafb6600af2633e4c98cc64c72f5269"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tquat&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#gaadafb6600af2633e4c98cc64c72f5269">make_quat</a> (T const *const ptr)</td></tr>
<tr class="memdesc:gaadafb6600af2633e4c98cc64c72f5269"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a quaternion from a pointer. <a href="a00178.html#gaadafb6600af2633e4c98cc64c72f5269">More...</a><br /></td></tr>
<tr class="separator:gaadafb6600af2633e4c98cc64c72f5269"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f7393c30970c5949be13ceb525093a6"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga5f7393c30970c5949be13ceb525093a6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec2&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga5f7393c30970c5949be13ceb525093a6">make_vec2</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga5f7393c30970c5949be13ceb525093a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a vector from a pointer. <a href="a00178.html#ga5f7393c30970c5949be13ceb525093a6">More...</a><br /></td></tr>
<tr class="separator:ga5f7393c30970c5949be13ceb525093a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga86f4bc63570db86346db2e567fb760f6"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga86f4bc63570db86346db2e567fb760f6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga86f4bc63570db86346db2e567fb760f6">make_vec3</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga86f4bc63570db86346db2e567fb760f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a vector from a pointer. <a href="a00178.html#ga86f4bc63570db86346db2e567fb760f6">More...</a><br /></td></tr>
<tr class="separator:ga86f4bc63570db86346db2e567fb760f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga152345176b8951c15711f6ed4f6fc237"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga152345176b8951c15711f6ed4f6fc237"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec4&lt; T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#ga152345176b8951c15711f6ed4f6fc237">make_vec4</a> (T const *const ptr)</td></tr>
<tr class="memdesc:ga152345176b8951c15711f6ed4f6fc237"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a vector from a pointer. <a href="a00178.html#ga152345176b8951c15711f6ed4f6fc237">More...</a><br /></td></tr>
<tr class="separator:ga152345176b8951c15711f6ed4f6fc237"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf019636bb8bd7c9efb7c7ce3bb23bcfc"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaf019636bb8bd7c9efb7c7ce3bb23bcfc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType::value_type const *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00178.html#gaf019636bb8bd7c9efb7c7ce3bb23bcfc">value_ptr</a> (genType const &amp;vec)</td></tr>
<tr class="memdesc:gaf019636bb8bd7c9efb7c7ce3bb23bcfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the constant address to the data of the input parameter. <a href="a00178.html#gaf019636bb8bd7c9efb7c7ce3bb23bcfc">More...</a><br /></td></tr>
<tr class="separator:gaf019636bb8bd7c9efb7c7ce3bb23bcfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Handles the interaction between pointers and vector, matrix types. </p>
<p>This extension defines an overloaded function, glm::value_ptr, which takes any of the <a class="el" href="a00159.html">core template types</a>. It returns a pointer to the memory layout of the object. Matrix types store their values in column-major order.</p>
<p>This extension defines an overloaded function, glm::value_ptr, which takes any of the <a class="el" href="a00158.html">core template types</a>. It returns a pointer to the memory layout of the object. Matrix types store their values in column-major order.</p>
<p>This is useful for uploading data to matrices or copying data to buffer objects.</p>
<p>Example: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="a00040.html">glm/glm.hpp</a>&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="a00125.html">glm/gtc/type_ptr.hpp</a>&gt;</span></div>
<p>Example: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="a00041.html">glm/glm.hpp</a>&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;<a class="code" href="a00123.html">glm/gtc/type_ptr.hpp</a>&gt;</span></div>
<div class="line"></div>
<div class="line"><a class="code" href="a00157.html#gaa8ea2429bb3cb41a715258a447f39897">glm::vec3</a> aVector(3);</div>
<div class="line"><a class="code" href="a00157.html#gade0eb47c01f79384a6f38017ede17446">glm::mat4</a> someMatrix(1.0);</div>
<div class="line"><a class="code" href="a00156.html#gaa8ea2429bb3cb41a715258a447f39897">glm::vec3</a> aVector(3);</div>
<div class="line"><a class="code" href="a00156.html#gade0eb47c01f79384a6f38017ede17446">glm::mat4</a> someMatrix(1.0);</div>
<div class="line"></div>
<div class="line">glUniform3fv(uniformLoc, 1, <a class="code" href="a00178.html#gaf019636bb8bd7c9efb7c7ce3bb23bcfc">glm::value_ptr</a>(aVector));</div>
<div class="line">glUniformMatrix4fv(uniformMatrixLoc, 1, GL_FALSE, <a class="code" href="a00178.html#gaf019636bb8bd7c9efb7c7ce3bb23bcfc">glm::value_ptr</a>(someMatrix));</div>
</div><!-- fragment --><p>&lt;<a class="el" href="a00125.html" title="GLM_GTC_type_ptr ">glm/gtc/type_ptr.hpp</a>&gt; need to be included to use these functionalities. </p>
</div><!-- fragment --><p>&lt;<a class="el" href="a00123.html" title="GLM_GTC_type_ptr ">glm/gtc/type_ptr.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga52a16e333fef7e33ca740779482a8693"></a>
<div class="memitem">