<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Matrix - pixi.js</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="http://www.goodboydigital.com/pixijs/logo_small.png" title="pixi.js"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 2.0.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/AbstractFilter.html">AbstractFilter</a></li>
<li><a href="../classes/AjaxRequest.html">AjaxRequest</a></li>
<li><a href="../classes/AlphaMaskFilter.html">AlphaMaskFilter</a></li>
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="../classes/AtlasLoader.html">AtlasLoader</a></li>
<li><a href="../classes/autoDetectRenderer.html">autoDetectRenderer</a></li>
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="../classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
<li><a href="../classes/BitmapText.html">BitmapText</a></li>
<li><a href="../classes/BlurFilter.html">BlurFilter</a></li>
<li><a href="../classes/CanvasGraphics.html">CanvasGraphics</a></li>
<li><a href="../classes/CanvasMaskManager.html">CanvasMaskManager</a></li>
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="../classes/CanvasTinter.html">CanvasTinter</a></li>
<li><a href="../classes/Circle.html">Circle</a></li>
<li><a href="../classes/ColorMatrixFilter.html">ColorMatrixFilter</a></li>
<li><a href="../classes/ColorStepFilter.html">ColorStepFilter</a></li>
<li><a href="../classes/ComplexPrimitiveShader.html">ComplexPrimitiveShader</a></li>
<li><a href="../classes/DisplacementFilter.html">DisplacementFilter</a></li>
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="../classes/DotScreenFilter.html">DotScreenFilter</a></li>
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
<li><a href="../classes/Event.html">Event</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="../classes/FilterTexture.html">FilterTexture</a></li>
<li><a href="../classes/getRecommendedRenderer.html">getRecommendedRenderer</a></li>
<li><a href="../classes/Graphics.html">Graphics</a></li>
<li><a href="../classes/GrayFilter.html">GrayFilter</a></li>
<li><a href="../classes/ImageLoader.html">ImageLoader</a></li>
<li><a href="../classes/InteractionData.html">InteractionData</a></li>
<li><a href="../classes/InteractionManager.html">InteractionManager</a></li>
<li><a href="../classes/InvertFilter.html">InvertFilter</a></li>
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
<li><a href="../classes/Matrix.html">Matrix</a></li>
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
<li><a href="../classes/NormalMapFilter.html">NormalMapFilter</a></li>
<li><a href="../classes/PixelateFilter.html">PixelateFilter</a></li>
<li><a href="../classes/PixiFastShader.html">PixiFastShader</a></li>
<li><a href="../classes/PixiShader.html">PixiShader</a></li>
<li><a href="../classes/Point.html">Point</a></li>
<li><a href="../classes/Polygon.html">Polygon</a></li>
<li><a href="../classes/PolyK.html">PolyK</a></li>
<li><a href="../classes/PrimitiveShader.html">PrimitiveShader</a></li>
<li><a href="../classes/Rectangle.html">Rectangle</a></li>
<li><a href="../classes/RenderTexture.html">RenderTexture</a></li>
<li><a href="../classes/Rope.html">Rope</a></li>
<li><a href="../classes/SepiaFilter.html">SepiaFilter</a></li>
<li><a href="../classes/Spine.html">Spine</a></li>
<li><a href="../classes/Sprite.html">Sprite</a></li>
<li><a href="../classes/SpriteBatch.html">SpriteBatch</a></li>
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="../classes/Stage.html">Stage</a></li>
<li><a href="../classes/Strip.html">Strip</a></li>
<li><a href="../classes/Text.html">Text</a></li>
<li><a href="../classes/Texture.html">Texture</a></li>
<li><a href="../classes/TilingSprite.html">TilingSprite</a></li>
<li><a href="../classes/TiltShiftFilter.html">TiltShiftFilter</a></li>
<li><a href="../classes/TwistFilter.html">TwistFilter</a></li>
<li><a href="../classes/WebGLFilterManager.html">WebGLFilterManager</a></li>
<li><a href="../classes/WebGLGraphics.html">WebGLGraphics</a></li>
<li><a href="../classes/WebGLMaskManager.html">WebGLMaskManager</a></li>
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
<li><a href="../classes/WebGLShaderManager.html">WebGLShaderManager</a></li>
<li><a href="../classes/WebGLSpriteBatch.html">WebGLSpriteBatch</a></li>
<li><a href="../classes/WebGLStencilManager.html">WebGLStencilManager</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/PIXI.html">PIXI</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Matrix Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_pixi_geom_Matrix.js.html#l5"><code>src/pixi/geom/Matrix.js:5</code></a>
</div>
Module: <a href="../modules/PIXI.html">PIXI</a>
</div>
<div class="box intro">
<p>The Matrix class is now an object, which makes it a lot faster,
here is a representation of it :
| a | b | tx|
| c | d | ty|
| 0 | 0 | 1 |</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Matrix" class="method item">
<h3 class="name"><code>Matrix</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l5"><code>src/pixi/geom/Matrix.js:5</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_apply">apply</a>
</li>
<li class="index-item method">
<a href="#method_apply">apply</a>
</li>
<li class="index-item method">
<a href="#method_fromArray">fromArray</a>
</li>
<li class="index-item method">
<a href="#method_rotate">rotate</a>
</li>
<li class="index-item method">
<a href="#method_scale">scale</a>
</li>
<li class="index-item method">
<a href="#method_toArray">toArray</a>
</li>
<li class="index-item method">
<a href="#method_translate">translate</a>
</li>
<li class="index-item method">
<a href="#method_translate">translate</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_apply" class="method item">
<h3 class="name"><code>apply</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>pos</code>
</li>
<li class="arg">
<code class="optional">[newPos]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l81"><code>src/pixi/geom/Matrix.js:81</code></a>
</p>
</div>
<div class="description">
<p>Get a new position with the current transormation applied.
Can be used to go from a child's coordinate space to the world coordinate space. (e.g. rendering)</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">pos</code>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="param-description">
<p>The origin</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[newPos]</code>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The point that the new position is assigned to (allowed to be same as input)</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>:
<p>The new point, transformed trough this matrix</p>
</div>
</div>
</div>
<div id="method_apply" class="method item">
<h3 class="name"><code>apply</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>pos</code>
</li>
<li class="arg">
<code class="optional">[newPos]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l100"><code>src/pixi/geom/Matrix.js:100</code></a>
</p>
</div>
<div class="description">
<p>Get a new position with the inverse of the current transormation applied.
Can be used to go from the world coordinate space to a child's coordinate space. (e.g. input)</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">pos</code>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<div class="param-description">
<p>The origin</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[newPos]</code>
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The point that the new position is assigned to (allowed to be same as input)</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>:
<p>The new point, inverse-transformed trough this matrix</p>
</div>
</div>
</div>
<div id="method_fromArray" class="method item">
<h3 class="name"><code>fromArray</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>array</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l25"><code>src/pixi/geom/Matrix.js:25</code></a>
</p>
</div>
<div class="description">
<p>Creates a pixi matrix object based on the array given as a parameter</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">array</code>
<span class="type">Array</span>
<div class="param-description">
<p>The array that the matrix will be filled with</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_rotate" class="method item">
<h3 class="name"><code>rotate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>angle</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l155"><code>src/pixi/geom/Matrix.js:155</code></a>
</p>
</div>
<div class="description">
<p>Applies a rotation transformation to the matrix.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">angle</code>
<span class="type">Number</span>
<div class="param-description">
<p>The angle in radians.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span>:
<p>This matrix. Good for chaining method calls.</p>
</div>
</div>
</div>
<div id="method_scale" class="method item">
<h3 class="name"><code>scale</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>x</code>
</li>
<li class="arg">
<code>y</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l135"><code>src/pixi/geom/Matrix.js:135</code></a>
</p>
</div>
<div class="description">
<p>Applies a scale transformation to the matrix.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">x</code>
<span class="type">Number</span>
<div class="param-description">
<p>The amount to scale horizontally</p>
</div>
</li>
<li class="param">
<code class="param-name">y</code>
<span class="type">Number</span>
<div class="param-description">
<p>The amount to scale vertically</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span>:
<p>This matrix. Good for chaining method calls.</p>
</div>
</div>
</div>
<div id="method_toArray" class="method item">
<h3 class="name"><code>toArray</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transpose</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l41"><code>src/pixi/geom/Matrix.js:41</code></a>
</p>
</div>
<div class="description">
<p>Creates an array from the current Matrix object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transpose</code>
<span class="type">Boolean</span>
<div class="param-description">
<p>Whether we need to transpose the matrix or not</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
<p>the newly created array which contains the matrix</p>
</div>
</div>
</div>
<div id="method_translate" class="method item">
<h3 class="name"><code>translate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>x</code>
</li>
<li class="arg">
<code>y</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l120"><code>src/pixi/geom/Matrix.js:120</code></a>
</p>
</div>
<div class="description">
<p>Translates the matrix on the x and y.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">x</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">y</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span>:
<p>This matrix. Good for chaining method calls.</p>
</div>
</div>
</div>
<div id="method_translate" class="method item">
<h3 class="name"><code>translate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>x</code>
</li>
<li class="arg">
<code>y</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_geom_Matrix.js.html#l181"><code>src/pixi/geom/Matrix.js:181</code></a>
</p>
</div>
<div class="description">
<p>Translates the matrix on the x and y.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">x</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">y</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Matrix.html" class="crosslink">Matrix</a></span>:
<p>This matrix. Good for chaining method calls.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
