mirror of
https://github.com/g-truc/glm.git
synced 2024-11-23 01:14:34 +00:00
6b1e7c6418
Replaced "documenation" with "documentation".
100 lines
22 KiB
HTML
100 lines
22 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>0.9.9 API documentation: matrix.hpp Source File</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>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">0.9.9 API documentation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_02cc19cee4c4780485bfe81520450212.html">christophericcio</a></li><li class="navelem"><a class="el" href="dir_54de7df3bc9880881b14ec07f256fd2e.html">Documents</a></li><li class="navelem"><a class="el" href="dir_6399a054f5929b58eaa476233e406ce8.html">Repository</a></li><li class="navelem"><a class="el" href="dir_627f4a52155b61a75c7c4851d7df9027.html">Github</a></li><li class="navelem"><a class="el" href="dir_ffdfd01cf51cdb2fe8bd5e55c6e0c4e8.html">glm</a></li><li class="navelem"><a class="el" href="dir_4ca6aa55b50e6be994025af27820140e.html">glm</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">matrix.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="a00644.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// Dependencies</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "detail/qualifier.hpp"</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "detail/setup.hpp"</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="a00650.html">vec2.hpp</a>"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="a00653.html">vec3.hpp</a>"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="a00656.html">vec4.hpp</a>"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="a00617.html">mat2x2.hpp</a>"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="a00620.html">mat2x3.hpp</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="a00623.html">mat2x4.hpp</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="a00626.html">mat3x2.hpp</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="a00629.html">mat3x3.hpp</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="a00632.html">mat3x4.hpp</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="a00635.html">mat4x2.hpp</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="a00638.html">mat4x3.hpp</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="a00641.html">mat4x4.hpp</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="a00792.html">glm</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>detail</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">template</span><length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">struct </span>outerProduct_trait{};</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">struct </span>outerProduct_trait<2, 2, T, Q></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">typedef</span> mat<2, 2, T, Q> type;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  };</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">struct </span>outerProduct_trait<2, 3, T, Q></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">typedef</span> mat<3, 2, T, Q> type;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  };</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">struct </span>outerProduct_trait<2, 4, T, Q></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">typedef</span> mat<4, 2, T, Q> type;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  };</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">struct </span>outerProduct_trait<3, 2, T, Q></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">typedef</span> mat<2, 3, T, Q> type;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  };</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">struct </span>outerProduct_trait<3, 3, T, Q></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">typedef</span> mat<3, 3, T, Q> type;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  };</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">struct </span>outerProduct_trait<3, 4, T, Q></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">typedef</span> mat<4, 3, T, Q> type;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  };</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">struct </span>outerProduct_trait<4, 2, T, Q></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">typedef</span> mat<2, 4, T, Q> type;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  };</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">struct </span>outerProduct_trait<4, 3, T, Q></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">typedef</span> mat<3, 4, T, Q> type;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  };</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">struct </span>outerProduct_trait<4, 4, T, Q></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">typedef</span> mat<4, 4, T, Q> type;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  };</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }<span class="comment">//namespace detail</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">template</span><length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  GLM_FUNC_DECL mat<C, R, T, Q> <a class="code" href="a00788.html#gaf14569404c779fedca98d0b9b8e58c1f">matrixCompMult</a>(mat<C, R, T, Q> <span class="keyword">const</span>& x, mat<C, R, T, Q> <span class="keyword">const</span>& y);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">template</span><length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  GLM_FUNC_DECL <span class="keyword">typename</span> detail::outerProduct_trait<C, R, T, Q>::type <a class="code" href="a00788.html#gac29fb7bae75a8e4c1b74cbbf85520e50">outerProduct</a>(vec<C, T, Q> <span class="keyword">const</span>& c, vec<R, T, Q> <span class="keyword">const</span>& r);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">template</span><length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  GLM_FUNC_DECL <span class="keyword">typename</span> mat<C, R, T, Q>::transpose_type <a class="code" href="a00788.html#gae679d841da8ce9dbcc6c2d454f15bc35">transpose</a>(mat<C, R, T, Q> <span class="keyword">const</span>& x);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">template</span><length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  GLM_FUNC_DECL T <a class="code" href="a00788.html#gad7928795124768e058f99dce270f5c8d">determinant</a>(mat<C, R, T, Q> <span class="keyword">const</span>& m);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">template</span><length_t C, length_t R, <span class="keyword">typename</span> T, qualifier Q></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  GLM_FUNC_DECL mat<C, R, T, Q> <a class="code" href="a00788.html#gaed509fe8129b01e4f20a6d0de5690091">inverse</a>(mat<C, R, T, Q> <span class="keyword">const</span>& m);</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> }<span class="comment">//namespace glm</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#include "detail/func_matrix.inl"</span></div><div class="ttc" id="a00788_html_gaed509fe8129b01e4f20a6d0de5690091"><div class="ttname"><a href="a00788.html#gaed509fe8129b01e4f20a6d0de5690091">glm::inverse</a></div><div class="ttdeci">GLM_FUNC_DECL mat< C, R, T, Q > inverse(mat< C, R, T, Q > const &m)</div><div class="ttdoc">Return the inverse of a squared matrix. </div></div>
|
|
<div class="ttc" id="a00788_html_gaf14569404c779fedca98d0b9b8e58c1f"><div class="ttname"><a href="a00788.html#gaf14569404c779fedca98d0b9b8e58c1f">glm::matrixCompMult</a></div><div class="ttdeci">GLM_FUNC_DECL mat< C, R, T, Q > matrixCompMult(mat< C, R, T, Q > const &x, mat< C, R, T, Q > const &y)</div><div class="ttdoc">Multiply matrix x by matrix y component-wise, i.e., result[i][j] is the scalar product of x[i][j] and...</div></div>
|
|
<div class="ttc" id="a00656_html"><div class="ttname"><a href="a00656.html">vec4.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00635_html"><div class="ttname"><a href="a00635.html">mat4x2.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00623_html"><div class="ttname"><a href="a00623.html">mat2x4.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00650_html"><div class="ttname"><a href="a00650.html">vec2.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00641_html"><div class="ttname"><a href="a00641.html">mat4x4.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00638_html"><div class="ttname"><a href="a00638.html">mat4x3.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00788_html_gac29fb7bae75a8e4c1b74cbbf85520e50"><div class="ttname"><a href="a00788.html#gac29fb7bae75a8e4c1b74cbbf85520e50">glm::outerProduct</a></div><div class="ttdeci">GLM_FUNC_DECL detail::outerProduct_trait< C, R, T, Q >::type outerProduct(vec< C, T, Q > const &c, vec< R, T, Q > const &r)</div><div class="ttdoc">Treats the first parameter c as a column vector and the second parameter r as a row vector and does a...</div></div>
|
|
<div class="ttc" id="a00626_html"><div class="ttname"><a href="a00626.html">mat3x2.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00629_html"><div class="ttname"><a href="a00629.html">mat3x3.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00617_html"><div class="ttname"><a href="a00617.html">mat2x2.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00632_html"><div class="ttname"><a href="a00632.html">mat3x4.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00620_html"><div class="ttname"><a href="a00620.html">mat2x3.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00792_html"><div class="ttname"><a href="a00792.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00002_source.html#l00020">common.hpp:20</a></div></div>
|
|
<div class="ttc" id="a00653_html"><div class="ttname"><a href="a00653.html">vec3.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00788_html_gad7928795124768e058f99dce270f5c8d"><div class="ttname"><a href="a00788.html#gad7928795124768e058f99dce270f5c8d">glm::determinant</a></div><div class="ttdeci">GLM_FUNC_DECL T determinant(mat< C, R, T, Q > const &m)</div><div class="ttdoc">Return the determinant of a squared matrix. </div></div>
|
|
<div class="ttc" id="a00788_html_gae679d841da8ce9dbcc6c2d454f15bc35"><div class="ttname"><a href="a00788.html#gae679d841da8ce9dbcc6c2d454f15bc35">glm::transpose</a></div><div class="ttdeci">GLM_FUNC_DECL mat< C, R, T, Q >::transpose_type transpose(mat< C, R, T, Q > const &x)</div><div class="ttdoc">Returns the transposed matrix of x. </div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.14
|
|
</small></address>
|
|
</body>
|
|
</html>
|