mirror of https://github.com/g-truc/glm.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
304 lines
17 KiB
HTML
304 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>1.0.0 API documentation: GLM_EXT_matrix_integer</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">1.0.0 API documentation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<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>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GLM_EXT_matrix_integer<div class="ingroups"><a class="el" href="a00894.html">Stable extensions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga07f545826ec7726ca072e587246afdde"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga07f545826ec7726ca072e587246afdde"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00825.html#ga07f545826ec7726ca072e587246afdde">determinant</a> (mat< C, R, T, Q > const &m)</td></tr>
|
|
<tr class="memdesc:ga07f545826ec7726ca072e587246afdde"><td class="mdescLeft"> </td><td class="mdescRight">Return the determinant of a squared matrix. <a href="a00825.html#ga07f545826ec7726ca072e587246afdde">More...</a><br /></td></tr>
|
|
<tr class="separator:ga07f545826ec7726ca072e587246afdde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga514c5f14f88b22355731a992e683fc90"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga514c5f14f88b22355731a992e683fc90"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< C, R, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00825.html#ga514c5f14f88b22355731a992e683fc90">matrixCompMult</a> (mat< C, R, T, Q > const &x, mat< C, R, T, Q > const &y)</td></tr>
|
|
<tr class="memdesc:ga514c5f14f88b22355731a992e683fc90"><td class="mdescLeft"> </td><td class="mdescRight">Multiply matrix x by matrix y component-wise, i.e., result[i][j] is the scalar product of x[i][j] and y[i][j]. <a href="a00825.html#ga514c5f14f88b22355731a992e683fc90">More...</a><br /></td></tr>
|
|
<tr class="separator:ga514c5f14f88b22355731a992e683fc90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga80d31e9320fd77035336e01d0228321f"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga80d31e9320fd77035336e01d0228321f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL detail::outerProduct_trait< C, R, T, Q >::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00825.html#ga80d31e9320fd77035336e01d0228321f">outerProduct</a> (vec< C, T, Q > const &c, vec< R, T, Q > const &r)</td></tr>
|
|
<tr class="memdesc:ga80d31e9320fd77035336e01d0228321f"><td class="mdescLeft"> </td><td class="mdescRight">Treats the first parameter c as a column vector and the second parameter r as a row vector and does a linear algebraic matrix multiply c * r. <a href="a00825.html#ga80d31e9320fd77035336e01d0228321f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga80d31e9320fd77035336e01d0228321f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4bedcb9c511484f38fd30a60c95f4679"><td class="memTemplParams" colspan="2">template<length_t C, length_t R, typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga4bedcb9c511484f38fd30a60c95f4679"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< C, R, T, Q >::transpose_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00825.html#ga4bedcb9c511484f38fd30a60c95f4679">transpose</a> (mat< C, R, T, Q > const &x)</td></tr>
|
|
<tr class="memdesc:ga4bedcb9c511484f38fd30a60c95f4679"><td class="mdescLeft"> </td><td class="mdescRight">Returns the transposed matrix of x. <a href="a00825.html#ga4bedcb9c511484f38fd30a60c95f4679">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4bedcb9c511484f38fd30a60c95f4679"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Defines functions that generate common transformation matrices.</p>
|
|
<p>The matrices generated by this extension use standard OpenGL fixed-function conventions. For example, the lookAt function generates a transform from world space into the specific eye space that the projective matrix functions (perspective, ortho, etc) are designed to expect. The OpenGL compatibility specifications defines the particular layout of this eye space.</p>
|
|
<p>Include <<a class="el" href="a01573.html" title="GLM_EXT_matrix_integer">glm/ext/matrix_integer.hpp</a>> to use the features of this extension.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00826.html">GLM_EXT_matrix_projection</a> </dd>
|
|
<dd>
|
|
<a class="el" href="a00805.html">GLM_EXT_matrix_clip_space</a> </dd></dl>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga07f545826ec7726ca072e587246afdde"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga07f545826ec7726ca072e587246afdde">◆ </a></span>determinant()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL T determinant </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< C, R, T, Q > const & </td>
|
|
<td class="paramname"><em>m</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the determinant of a squared matrix. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
|
|
<tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
|
|
<tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/determinant.xml">GLSL determinant man page</a> </dd>
|
|
<dd>
|
|
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
|
|
<tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
|
|
<tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/determinant.xml">GLSL determinant man page</a> </dd>
|
|
<dd>
|
|
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga514c5f14f88b22355731a992e683fc90"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga514c5f14f88b22355731a992e683fc90">◆ </a></span>matrixCompMult()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL mat< C, R, T, Q > matrixCompMult </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< C, R, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">mat< C, R, T, Q > const & </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Multiply matrix x by matrix y component-wise, i.e., result[i][j] is the scalar product of x[i][j] and y[i][j]. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
|
|
<tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
|
|
<tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/matrixCompMult.xml">GLSL matrixCompMult man page</a> </dd>
|
|
<dd>
|
|
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
|
|
<tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
|
|
<tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/matrixCompMult.xml">GLSL matrixCompMult man page</a> </dd>
|
|
<dd>
|
|
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga80d31e9320fd77035336e01d0228321f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga80d31e9320fd77035336e01d0228321f">◆ </a></span>outerProduct()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL detail::outerProduct_trait< C, R, T, Q >::type outerProduct </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< C, T, Q > const & </td>
|
|
<td class="paramname"><em>c</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< R, T, Q > const & </td>
|
|
<td class="paramname"><em>r</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Treats the first parameter c as a column vector and the second parameter r as a row vector and does a linear algebraic matrix multiply c * r. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
|
|
<tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
|
|
<tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/outerProduct.xml">GLSL outerProduct man page</a> </dd>
|
|
<dd>
|
|
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
|
|
<tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
|
|
<tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/outerProduct.xml">GLSL outerProduct man page</a> </dd>
|
|
<dd>
|
|
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4bedcb9c511484f38fd30a60c95f4679"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4bedcb9c511484f38fd30a60c95f4679">◆ </a></span>transpose()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL mat< C, R, T, Q >::transpose_type transpose </td>
|
|
<td>(</td>
|
|
<td class="paramtype">mat< C, R, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the transposed matrix of x. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
|
|
<tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
|
|
<tr><td class="paramname">T</td><td>Floating-point or signed integer scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/transpose.xml">GLSL transpose man page</a> </dd>
|
|
<dd>
|
|
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">C</td><td>Integer between 1 and 4 included that qualify the number a column </td></tr>
|
|
<tr><td class="paramname">R</td><td>Integer between 1 and 4 included that qualify the number a row </td></tr>
|
|
<tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
|
|
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/transpose.xml">GLSL transpose man page</a> </dd>
|
|
<dd>
|
|
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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.18
|
|
</small></address>
|
|
</body>
|
|
</html>
|