gl-matrix/docs/mat3.html
Brandon Jones e9a25db193 Rebuilding the docs for the first time in ages
Formatting isn't as pretty, but that can come later.
2016-05-01 12:18:49 -07:00

5799 lines
63 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: mat3</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: mat3</h1>
<section>
<header>
<h2>mat3</h2>
<div class="class-description">3x3 Matrix</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="mat3"><span class="type-signature"></span>new mat3<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".add"><span class="type-signature">(static) </span>add<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Adds two mat3's
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the first operand</td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the second operand</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line628">line 628</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".adjoint"><span class="type-signature">(static) </span>adjoint<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Calculates the adjugate of a mat3
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the source matrix</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line258">line 258</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".clone"><span class="type-signature">(static) </span>clone<span class="signature">(a)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Creates a new mat3 initialized with values from an existing matrix
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">matrix to clone</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
a new 3x3 matrix
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".copy"><span class="type-signature">(static) </span>copy<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Copy the values from one mat3 to another
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the source matrix</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Creates a new identity mat3
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
a new 3x3 matrix
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".determinant"><span class="type-signature">(static) </span>determinant<span class="signature">(a)</span><span class="type-signature"> &rarr; {Number}</span></h4>
<div class="description">
Calculates the determinant of a mat3
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the source matrix</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line281">line 281</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
determinant of a
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
<h4 class="name" id=".equals"><span class="type-signature">(static) </span>equals<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
<div class="description">
Returns whether or not the matrices have approximately the same elements in the same position.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">The first matrix.</td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">The second matrix.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line731">line 731</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if the matrices are equal, false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id=".exactEquals"><span class="type-signature">(static) </span>exactEquals<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
<div class="description">
Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">The first matrix.</td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">The second matrix.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line718">line 718</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if the matrices are equal, false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id=".frob"><span class="type-signature">(static) </span>frob<span class="signature">(a)</span><span class="type-signature"> &rarr; {Number}</span></h4>
<div class="description">
Returns Frobenius norm of a mat3
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the matrix to calculate Frobenius norm of</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line616">line 616</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Frobenius norm
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
<h4 class="name" id=".fromMat2d"><span class="type-signature">(static) </span>fromMat2d<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Copies the values from a mat2d into a mat3
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat2d.html">mat2d</a></span>
</td>
<td class="description last">the matrix to copy</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line494">line 494</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".fromMat4"><span class="type-signature">(static) </span>fromMat4<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Copies the upper-left 3x3 values into the given mat3.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving 3x3 matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat4.html">mat4</a></span>
</td>
<td class="description last">the source 4x4 matrix</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".fromQuat"><span class="type-signature">(static) </span>fromQuat<span class="signature">(out, q)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Calculates a 3x3 matrix from the given quaternion
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">mat3 receiving operation result</td>
</tr>
<tr>
<td class="name"><code>q</code></td>
<td class="type">
<span class="param-type"><a href="quat.html">quat</a></span>
</td>
<td class="description last">Quaternion to create matrix from</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line517">line 517</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".fromRotation"><span class="type-signature">(static) </span>fromRotation<span class="signature">(out, rad)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Creates a matrix from a given angle
This is equivalent to (but much faster than):
mat3.identity(dest);
mat3.rotate(dest, dest, rad);
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">mat3 receiving operation result</td>
</tr>
<tr>
<td class="name"><code>rad</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">the angle to rotate the matrix by</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line444">line 444</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".fromScaling"><span class="type-signature">(static) </span>fromScaling<span class="signature">(out, v)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Creates a matrix from a vector scaling
This is equivalent to (but much faster than):
mat3.identity(dest);
mat3.scale(dest, dest, vec);
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">mat3 receiving operation result</td>
</tr>
<tr>
<td class="name"><code>v</code></td>
<td class="type">
<span class="param-type"><a href="vec2.html">vec2</a></span>
</td>
<td class="description last">Scaling vector</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line472">line 472</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".fromTranslation"><span class="type-signature">(static) </span>fromTranslation<span class="signature">(out, v)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Creates a matrix from a vector translation
This is equivalent to (but much faster than):
mat3.identity(dest);
mat3.translate(dest, dest, vec);
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">mat3 receiving operation result</td>
</tr>
<tr>
<td class="name"><code>v</code></td>
<td class="type">
<span class="param-type"><a href="vec2.html">vec2</a></span>
</td>
<td class="description last">Translation vector</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line420">line 420</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".fromValues"><span class="type-signature">(static) </span>fromValues<span class="signature">(m00, m01, m02, m10, m11, m12, m20, m21, m22)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Create a new mat3 with the given values
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>m00</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 0, row 0 position (index 0)</td>
</tr>
<tr>
<td class="name"><code>m01</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 0, row 1 position (index 1)</td>
</tr>
<tr>
<td class="name"><code>m02</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 0, row 2 position (index 2)</td>
</tr>
<tr>
<td class="name"><code>m10</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 1, row 0 position (index 3)</td>
</tr>
<tr>
<td class="name"><code>m11</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 1, row 1 position (index 4)</td>
</tr>
<tr>
<td class="name"><code>m12</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 1, row 2 position (index 5)</td>
</tr>
<tr>
<td class="name"><code>m20</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 2, row 0 position (index 6)</td>
</tr>
<tr>
<td class="name"><code>m21</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 2, row 1 position (index 7)</td>
</tr>
<tr>
<td class="name"><code>m22</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 2, row 2 position (index 8)</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A new mat3
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".identity"><span class="type-signature">(static) </span>identity<span class="signature">(out)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Set a mat3 to the identity matrix
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line170">line 170</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".invert"><span class="type-signature">(static) </span>invert<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Inverts a mat3
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the source matrix</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line222">line 222</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".mul"><span class="type-signature">(static) </span>mul<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Alias for <a href="mat3.html#.multiply">mat3.multiply</a>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line324">line 324</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".multiply"><span class="type-signature">(static) </span>multiply<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Multiplies two mat3's
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the first operand</td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the second operand</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line297">line 297</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".multiplyScalar"><span class="type-signature">(static) </span>multiplyScalar<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Multiply each element of the matrix by a scalar.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the matrix to scale</td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">amount to scale the matrix's elements by</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line676">line 676</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".multiplyScalarAndAdd"><span class="type-signature">(static) </span>multiplyScalarAndAdd<span class="signature">(out, a, b, scale)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Adds two mat3's after multiplying each element of the second operand by a scalar value.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving vector</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the first operand</td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the second operand</td>
</tr>
<tr>
<td class="name"><code>scale</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">the amount to scale b's elements by before adding</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line698">line 698</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".normalFromMat4"><span class="type-signature">(static) </span>normalFromMat4<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Calculates a 3x3 normal matrix (transpose inverse) from the 4x4 matrix
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">mat3 receiving operation result</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat4.html">mat4</a></span>
</td>
<td class="description last">Mat4 to derive the normal matrix from</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line556">line 556</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".rotate"><span class="type-signature">(static) </span>rotate<span class="signature">(out, a, rad)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Rotates a mat3 by the given angle
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the matrix to rotate</td>
</tr>
<tr>
<td class="name"><code>rad</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">the angle to rotate the matrix by</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line362">line 362</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".scale"><span class="type-signature">(static) </span>scale<span class="signature">(out, a, v)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Scales the mat3 by the dimensions in the given vec2
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the matrix to rotate</td>
</tr>
<tr>
<td class="name"><code>v</code></td>
<td class="type">
<span class="param-type"><a href="vec2.html">vec2</a></span>
</td>
<td class="description last">the vec2 to scale the matrix by</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line392">line 392</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".set"><span class="type-signature">(static) </span>set<span class="signature">(out, m00, m01, m02, m10, m11, m12, m20, m21, m22)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Set the components of a mat3 to the given values
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>m00</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 0, row 0 position (index 0)</td>
</tr>
<tr>
<td class="name"><code>m01</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 0, row 1 position (index 1)</td>
</tr>
<tr>
<td class="name"><code>m02</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 0, row 2 position (index 2)</td>
</tr>
<tr>
<td class="name"><code>m10</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 1, row 0 position (index 3)</td>
</tr>
<tr>
<td class="name"><code>m11</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 1, row 1 position (index 4)</td>
</tr>
<tr>
<td class="name"><code>m12</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 1, row 2 position (index 5)</td>
</tr>
<tr>
<td class="name"><code>m20</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 2, row 0 position (index 6)</td>
</tr>
<tr>
<td class="name"><code>m21</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 2, row 1 position (index 7)</td>
</tr>
<tr>
<td class="name"><code>m22</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Component in column 2, row 2 position (index 8)</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line151">line 151</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".str"><span class="type-signature">(static) </span>str<span class="signature">(a)</span><span class="type-signature"> &rarr; {String}</span></h4>
<div class="description">
Returns a string representation of a mat3
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">matrix to represent as a string</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line604">line 604</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
string representation of the matrix
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".sub"><span class="type-signature">(static) </span>sub<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Alias for <a href="mat3.html#.subtract">mat3.subtract</a>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line666">line 666</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".subtract"><span class="type-signature">(static) </span>subtract<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Subtracts matrix b from matrix a
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the first operand</td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the second operand</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line649">line 649</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".translate"><span class="type-signature">(static) </span>translate<span class="signature">(out, a, v)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Translate a mat3 by the given vector
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the matrix to translate</td>
</tr>
<tr>
<td class="name"><code>v</code></td>
<td class="type">
<span class="param-type"><a href="vec2.html">vec2</a></span>
</td>
<td class="description last">vector to translate by</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line334">line 334</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
<h4 class="name" id=".transpose"><span class="type-signature">(static) </span>transpose<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {<a href="mat3.html">mat3</a>}</span></h4>
<div class="description">
Transpose the values of a mat3
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the receiving matrix</td>
</tr>
<tr>
<td class="name"><code>a</code></td>
<td class="type">
<span class="param-type"><a href="mat3.html">mat3</a></span>
</td>
<td class="description last">the source matrix</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mat3.js.html">mat3.js</a>, <a href="mat3.js.html#line190">line 190</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
out
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="mat3.html">mat3</a></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="glMatrix.html">glMatrix</a></li><li><a href="mat2.html">mat2</a></li><li><a href="mat2d.html">mat2d</a></li><li><a href="mat3.html">mat3</a></li><li><a href="mat4.html">mat4</a></li><li><a href="quat.html">quat</a></li><li><a href="vec2.html">vec2</a></li><li><a href="vec3.html">vec3</a></li><li><a href="vec4.html">vec4</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun May 01 2016 12:11:58 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>