module-mat2d.html 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Module: mat2d</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Module: mat2d</h1>
  17. <section>
  18. <header>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <div class="description">A mat2d contains six elements defined as:
  23. <pre>
  24. [a, c, tx,
  25. b, d, ty]
  26. </pre>
  27. This is a short form for the 3x3 matrix:
  28. <pre>
  29. [a, c, tx,
  30. b, d, ty,
  31. 0, 0, 1]
  32. </pre>
  33. The last row is ignored so the array is shorter and operations are faster.</div>
  34. <dl class="details">
  35. <dt class="tag-source">Source:</dt>
  36. <dd class="tag-source"><ul class="dummy"><li>
  37. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line3">line 3</a>
  38. </li></ul></dd>
  39. </dl>
  40. </div>
  41. <h3 class="subsection-title">Methods</h3>
  42. <h4 class="name" id=".add"><span class="type-signature">(static) </span>add<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  43. <div class="description">
  44. Adds two mat2d's
  45. </div>
  46. <h5>Parameters:</h5>
  47. <table class="params">
  48. <thead>
  49. <tr>
  50. <th>Name</th>
  51. <th>Type</th>
  52. <th class="last">Description</th>
  53. </tr>
  54. </thead>
  55. <tbody>
  56. <tr>
  57. <td class="name"><code>out</code></td>
  58. <td class="type">
  59. <span class="param-type">mat2d</span>
  60. </td>
  61. <td class="description last">the receiving matrix</td>
  62. </tr>
  63. <tr>
  64. <td class="name"><code>a</code></td>
  65. <td class="type">
  66. <span class="param-type">mat2d</span>
  67. </td>
  68. <td class="description last">the first operand</td>
  69. </tr>
  70. <tr>
  71. <td class="name"><code>b</code></td>
  72. <td class="type">
  73. <span class="param-type">mat2d</span>
  74. </td>
  75. <td class="description last">the second operand</td>
  76. </tr>
  77. </tbody>
  78. </table>
  79. <dl class="details">
  80. <dt class="tag-source">Source:</dt>
  81. <dd class="tag-source"><ul class="dummy"><li>
  82. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line344">line 344</a>
  83. </li></ul></dd>
  84. </dl>
  85. <h5>Returns:</h5>
  86. <div class="param-desc">
  87. out
  88. </div>
  89. <dl>
  90. <dt>
  91. Type
  92. </dt>
  93. <dd>
  94. <span class="param-type">mat2d</span>
  95. </dd>
  96. </dl>
  97. <h4 class="name" id=".clone"><span class="type-signature">(static) </span>clone<span class="signature">(a)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  98. <div class="description">
  99. Creates a new mat2d initialized with values from an existing matrix
  100. </div>
  101. <h5>Parameters:</h5>
  102. <table class="params">
  103. <thead>
  104. <tr>
  105. <th>Name</th>
  106. <th>Type</th>
  107. <th class="last">Description</th>
  108. </tr>
  109. </thead>
  110. <tbody>
  111. <tr>
  112. <td class="name"><code>a</code></td>
  113. <td class="type">
  114. <span class="param-type">mat2d</span>
  115. </td>
  116. <td class="description last">matrix to clone</td>
  117. </tr>
  118. </tbody>
  119. </table>
  120. <dl class="details">
  121. <dt class="tag-source">Source:</dt>
  122. <dd class="tag-source"><ul class="dummy"><li>
  123. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line46">line 46</a>
  124. </li></ul></dd>
  125. </dl>
  126. <h5>Returns:</h5>
  127. <div class="param-desc">
  128. a new 2x3 matrix
  129. </div>
  130. <dl>
  131. <dt>
  132. Type
  133. </dt>
  134. <dd>
  135. <span class="param-type">mat2d</span>
  136. </dd>
  137. </dl>
  138. <h4 class="name" id=".copy"><span class="type-signature">(static) </span>copy<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  139. <div class="description">
  140. Copy the values from one mat2d to another
  141. </div>
  142. <h5>Parameters:</h5>
  143. <table class="params">
  144. <thead>
  145. <tr>
  146. <th>Name</th>
  147. <th>Type</th>
  148. <th class="last">Description</th>
  149. </tr>
  150. </thead>
  151. <tbody>
  152. <tr>
  153. <td class="name"><code>out</code></td>
  154. <td class="type">
  155. <span class="param-type">mat2d</span>
  156. </td>
  157. <td class="description last">the receiving matrix</td>
  158. </tr>
  159. <tr>
  160. <td class="name"><code>a</code></td>
  161. <td class="type">
  162. <span class="param-type">mat2d</span>
  163. </td>
  164. <td class="description last">the source matrix</td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. <dl class="details">
  169. <dt class="tag-source">Source:</dt>
  170. <dd class="tag-source"><ul class="dummy"><li>
  171. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line64">line 64</a>
  172. </li></ul></dd>
  173. </dl>
  174. <h5>Returns:</h5>
  175. <div class="param-desc">
  176. out
  177. </div>
  178. <dl>
  179. <dt>
  180. Type
  181. </dt>
  182. <dd>
  183. <span class="param-type">mat2d</span>
  184. </dd>
  185. </dl>
  186. <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">()</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  187. <div class="description">
  188. Creates a new identity mat2d
  189. </div>
  190. <dl class="details">
  191. <dt class="tag-source">Source:</dt>
  192. <dd class="tag-source"><ul class="dummy"><li>
  193. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line27">line 27</a>
  194. </li></ul></dd>
  195. </dl>
  196. <h5>Returns:</h5>
  197. <div class="param-desc">
  198. a new 2x3 matrix
  199. </div>
  200. <dl>
  201. <dt>
  202. Type
  203. </dt>
  204. <dd>
  205. <span class="param-type">mat2d</span>
  206. </dd>
  207. </dl>
  208. <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>
  209. <div class="description">
  210. Calculates the determinant of a mat2d
  211. </div>
  212. <h5>Parameters:</h5>
  213. <table class="params">
  214. <thead>
  215. <tr>
  216. <th>Name</th>
  217. <th>Type</th>
  218. <th class="last">Description</th>
  219. </tr>
  220. </thead>
  221. <tbody>
  222. <tr>
  223. <td class="name"><code>a</code></td>
  224. <td class="type">
  225. <span class="param-type">mat2d</span>
  226. </td>
  227. <td class="description last">the source matrix</td>
  228. </tr>
  229. </tbody>
  230. </table>
  231. <dl class="details">
  232. <dt class="tag-source">Source:</dt>
  233. <dd class="tag-source"><ul class="dummy"><li>
  234. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line166">line 166</a>
  235. </li></ul></dd>
  236. </dl>
  237. <h5>Returns:</h5>
  238. <div class="param-desc">
  239. determinant of a
  240. </div>
  241. <dl>
  242. <dt>
  243. Type
  244. </dt>
  245. <dd>
  246. <span class="param-type">Number</span>
  247. </dd>
  248. </dl>
  249. <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>
  250. <div class="description">
  251. Returns whether or not the matrices have approximately the same elements in the same position.
  252. </div>
  253. <h5>Parameters:</h5>
  254. <table class="params">
  255. <thead>
  256. <tr>
  257. <th>Name</th>
  258. <th>Type</th>
  259. <th class="last">Description</th>
  260. </tr>
  261. </thead>
  262. <tbody>
  263. <tr>
  264. <td class="name"><code>a</code></td>
  265. <td class="type">
  266. <span class="param-type">mat2d</span>
  267. </td>
  268. <td class="description last">The first matrix.</td>
  269. </tr>
  270. <tr>
  271. <td class="name"><code>b</code></td>
  272. <td class="type">
  273. <span class="param-type">mat2d</span>
  274. </td>
  275. <td class="description last">The second matrix.</td>
  276. </tr>
  277. </tbody>
  278. </table>
  279. <dl class="details">
  280. <dt class="tag-source">Source:</dt>
  281. <dd class="tag-source"><ul class="dummy"><li>
  282. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line427">line 427</a>
  283. </li></ul></dd>
  284. </dl>
  285. <h5>Returns:</h5>
  286. <div class="param-desc">
  287. True if the matrices are equal, false otherwise.
  288. </div>
  289. <dl>
  290. <dt>
  291. Type
  292. </dt>
  293. <dd>
  294. <span class="param-type">Boolean</span>
  295. </dd>
  296. </dl>
  297. <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>
  298. <div class="description">
  299. Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)
  300. </div>
  301. <h5>Parameters:</h5>
  302. <table class="params">
  303. <thead>
  304. <tr>
  305. <th>Name</th>
  306. <th>Type</th>
  307. <th class="last">Description</th>
  308. </tr>
  309. </thead>
  310. <tbody>
  311. <tr>
  312. <td class="name"><code>a</code></td>
  313. <td class="type">
  314. <span class="param-type">mat2d</span>
  315. </td>
  316. <td class="description last">The first matrix.</td>
  317. </tr>
  318. <tr>
  319. <td class="name"><code>b</code></td>
  320. <td class="type">
  321. <span class="param-type">mat2d</span>
  322. </td>
  323. <td class="description last">The second matrix.</td>
  324. </tr>
  325. </tbody>
  326. </table>
  327. <dl class="details">
  328. <dt class="tag-source">Source:</dt>
  329. <dd class="tag-source"><ul class="dummy"><li>
  330. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line416">line 416</a>
  331. </li></ul></dd>
  332. </dl>
  333. <h5>Returns:</h5>
  334. <div class="param-desc">
  335. True if the matrices are equal, false otherwise.
  336. </div>
  337. <dl>
  338. <dt>
  339. Type
  340. </dt>
  341. <dd>
  342. <span class="param-type">Boolean</span>
  343. </dd>
  344. </dl>
  345. <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>
  346. <div class="description">
  347. Returns Frobenius norm of a mat2d
  348. </div>
  349. <h5>Parameters:</h5>
  350. <table class="params">
  351. <thead>
  352. <tr>
  353. <th>Name</th>
  354. <th>Type</th>
  355. <th class="last">Description</th>
  356. </tr>
  357. </thead>
  358. <tbody>
  359. <tr>
  360. <td class="name"><code>a</code></td>
  361. <td class="type">
  362. <span class="param-type">mat2d</span>
  363. </td>
  364. <td class="description last">the matrix to calculate Frobenius norm of</td>
  365. </tr>
  366. </tbody>
  367. </table>
  368. <dl class="details">
  369. <dt class="tag-source">Source:</dt>
  370. <dd class="tag-source"><ul class="dummy"><li>
  371. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line332">line 332</a>
  372. </li></ul></dd>
  373. </dl>
  374. <h5>Returns:</h5>
  375. <div class="param-desc">
  376. Frobenius norm
  377. </div>
  378. <dl>
  379. <dt>
  380. Type
  381. </dt>
  382. <dd>
  383. <span class="param-type">Number</span>
  384. </dd>
  385. </dl>
  386. <h4 class="name" id=".fromRotation"><span class="type-signature">(static) </span>fromRotation<span class="signature">(out, rad)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  387. <div class="description">
  388. Creates a matrix from a given angle
  389. This is equivalent to (but much faster than):
  390. mat2d.identity(dest);
  391. mat2d.rotate(dest, dest, rad);
  392. </div>
  393. <h5>Parameters:</h5>
  394. <table class="params">
  395. <thead>
  396. <tr>
  397. <th>Name</th>
  398. <th>Type</th>
  399. <th class="last">Description</th>
  400. </tr>
  401. </thead>
  402. <tbody>
  403. <tr>
  404. <td class="name"><code>out</code></td>
  405. <td class="type">
  406. <span class="param-type">mat2d</span>
  407. </td>
  408. <td class="description last">mat2d receiving operation result</td>
  409. </tr>
  410. <tr>
  411. <td class="name"><code>rad</code></td>
  412. <td class="type">
  413. <span class="param-type">Number</span>
  414. </td>
  415. <td class="description last">the angle to rotate the matrix by</td>
  416. </tr>
  417. </tbody>
  418. </table>
  419. <dl class="details">
  420. <dt class="tag-source">Source:</dt>
  421. <dd class="tag-source"><ul class="dummy"><li>
  422. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line262">line 262</a>
  423. </li></ul></dd>
  424. </dl>
  425. <h5>Returns:</h5>
  426. <div class="param-desc">
  427. out
  428. </div>
  429. <dl>
  430. <dt>
  431. Type
  432. </dt>
  433. <dd>
  434. <span class="param-type">mat2d</span>
  435. </dd>
  436. </dl>
  437. <h4 class="name" id=".fromScaling"><span class="type-signature">(static) </span>fromScaling<span class="signature">(out, v)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  438. <div class="description">
  439. Creates a matrix from a vector scaling
  440. This is equivalent to (but much faster than):
  441. mat2d.identity(dest);
  442. mat2d.scale(dest, dest, vec);
  443. </div>
  444. <h5>Parameters:</h5>
  445. <table class="params">
  446. <thead>
  447. <tr>
  448. <th>Name</th>
  449. <th>Type</th>
  450. <th class="last">Description</th>
  451. </tr>
  452. </thead>
  453. <tbody>
  454. <tr>
  455. <td class="name"><code>out</code></td>
  456. <td class="type">
  457. <span class="param-type">mat2d</span>
  458. </td>
  459. <td class="description last">mat2d receiving operation result</td>
  460. </tr>
  461. <tr>
  462. <td class="name"><code>v</code></td>
  463. <td class="type">
  464. <span class="param-type">vec2</span>
  465. </td>
  466. <td class="description last">Scaling vector</td>
  467. </tr>
  468. </tbody>
  469. </table>
  470. <dl class="details">
  471. <dt class="tag-source">Source:</dt>
  472. <dd class="tag-source"><ul class="dummy"><li>
  473. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line284">line 284</a>
  474. </li></ul></dd>
  475. </dl>
  476. <h5>Returns:</h5>
  477. <div class="param-desc">
  478. out
  479. </div>
  480. <dl>
  481. <dt>
  482. Type
  483. </dt>
  484. <dd>
  485. <span class="param-type">mat2d</span>
  486. </dd>
  487. </dl>
  488. <h4 class="name" id=".fromTranslation"><span class="type-signature">(static) </span>fromTranslation<span class="signature">(out, v)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  489. <div class="description">
  490. Creates a matrix from a vector translation
  491. This is equivalent to (but much faster than):
  492. mat2d.identity(dest);
  493. mat2d.translate(dest, dest, vec);
  494. </div>
  495. <h5>Parameters:</h5>
  496. <table class="params">
  497. <thead>
  498. <tr>
  499. <th>Name</th>
  500. <th>Type</th>
  501. <th class="last">Description</th>
  502. </tr>
  503. </thead>
  504. <tbody>
  505. <tr>
  506. <td class="name"><code>out</code></td>
  507. <td class="type">
  508. <span class="param-type">mat2d</span>
  509. </td>
  510. <td class="description last">mat2d receiving operation result</td>
  511. </tr>
  512. <tr>
  513. <td class="name"><code>v</code></td>
  514. <td class="type">
  515. <span class="param-type">vec2</span>
  516. </td>
  517. <td class="description last">Translation vector</td>
  518. </tr>
  519. </tbody>
  520. </table>
  521. <dl class="details">
  522. <dt class="tag-source">Source:</dt>
  523. <dd class="tag-source"><ul class="dummy"><li>
  524. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line305">line 305</a>
  525. </li></ul></dd>
  526. </dl>
  527. <h5>Returns:</h5>
  528. <div class="param-desc">
  529. out
  530. </div>
  531. <dl>
  532. <dt>
  533. Type
  534. </dt>
  535. <dd>
  536. <span class="param-type">mat2d</span>
  537. </dd>
  538. </dl>
  539. <h4 class="name" id=".fromValues"><span class="type-signature">(static) </span>fromValues<span class="signature">(a, b, c, d, tx, ty)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  540. <div class="description">
  541. Create a new mat2d with the given values
  542. </div>
  543. <h5>Parameters:</h5>
  544. <table class="params">
  545. <thead>
  546. <tr>
  547. <th>Name</th>
  548. <th>Type</th>
  549. <th class="last">Description</th>
  550. </tr>
  551. </thead>
  552. <tbody>
  553. <tr>
  554. <td class="name"><code>a</code></td>
  555. <td class="type">
  556. <span class="param-type">Number</span>
  557. </td>
  558. <td class="description last">Component A (index 0)</td>
  559. </tr>
  560. <tr>
  561. <td class="name"><code>b</code></td>
  562. <td class="type">
  563. <span class="param-type">Number</span>
  564. </td>
  565. <td class="description last">Component B (index 1)</td>
  566. </tr>
  567. <tr>
  568. <td class="name"><code>c</code></td>
  569. <td class="type">
  570. <span class="param-type">Number</span>
  571. </td>
  572. <td class="description last">Component C (index 2)</td>
  573. </tr>
  574. <tr>
  575. <td class="name"><code>d</code></td>
  576. <td class="type">
  577. <span class="param-type">Number</span>
  578. </td>
  579. <td class="description last">Component D (index 3)</td>
  580. </tr>
  581. <tr>
  582. <td class="name"><code>tx</code></td>
  583. <td class="type">
  584. <span class="param-type">Number</span>
  585. </td>
  586. <td class="description last">Component TX (index 4)</td>
  587. </tr>
  588. <tr>
  589. <td class="name"><code>ty</code></td>
  590. <td class="type">
  591. <span class="param-type">Number</span>
  592. </td>
  593. <td class="description last">Component TY (index 5)</td>
  594. </tr>
  595. </tbody>
  596. </table>
  597. <dl class="details">
  598. <dt class="tag-source">Source:</dt>
  599. <dd class="tag-source"><ul class="dummy"><li>
  600. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line101">line 101</a>
  601. </li></ul></dd>
  602. </dl>
  603. <h5>Returns:</h5>
  604. <div class="param-desc">
  605. A new mat2d
  606. </div>
  607. <dl>
  608. <dt>
  609. Type
  610. </dt>
  611. <dd>
  612. <span class="param-type">mat2d</span>
  613. </dd>
  614. </dl>
  615. <h4 class="name" id=".identity"><span class="type-signature">(static) </span>identity<span class="signature">(out)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  616. <div class="description">
  617. Set a mat2d to the identity matrix
  618. </div>
  619. <h5>Parameters:</h5>
  620. <table class="params">
  621. <thead>
  622. <tr>
  623. <th>Name</th>
  624. <th>Type</th>
  625. <th class="last">Description</th>
  626. </tr>
  627. </thead>
  628. <tbody>
  629. <tr>
  630. <td class="name"><code>out</code></td>
  631. <td class="type">
  632. <span class="param-type">mat2d</span>
  633. </td>
  634. <td class="description last">the receiving matrix</td>
  635. </tr>
  636. </tbody>
  637. </table>
  638. <dl class="details">
  639. <dt class="tag-source">Source:</dt>
  640. <dd class="tag-source"><ul class="dummy"><li>
  641. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line80">line 80</a>
  642. </li></ul></dd>
  643. </dl>
  644. <h5>Returns:</h5>
  645. <div class="param-desc">
  646. out
  647. </div>
  648. <dl>
  649. <dt>
  650. Type
  651. </dt>
  652. <dd>
  653. <span class="param-type">mat2d</span>
  654. </dd>
  655. </dl>
  656. <h4 class="name" id=".invert"><span class="type-signature">(static) </span>invert<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  657. <div class="description">
  658. Inverts a mat2d
  659. </div>
  660. <h5>Parameters:</h5>
  661. <table class="params">
  662. <thead>
  663. <tr>
  664. <th>Name</th>
  665. <th>Type</th>
  666. <th class="last">Description</th>
  667. </tr>
  668. </thead>
  669. <tbody>
  670. <tr>
  671. <td class="name"><code>out</code></td>
  672. <td class="type">
  673. <span class="param-type">mat2d</span>
  674. </td>
  675. <td class="description last">the receiving matrix</td>
  676. </tr>
  677. <tr>
  678. <td class="name"><code>a</code></td>
  679. <td class="type">
  680. <span class="param-type">mat2d</span>
  681. </td>
  682. <td class="description last">the source matrix</td>
  683. </tr>
  684. </tbody>
  685. </table>
  686. <dl class="details">
  687. <dt class="tag-source">Source:</dt>
  688. <dd class="tag-source"><ul class="dummy"><li>
  689. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line141">line 141</a>
  690. </li></ul></dd>
  691. </dl>
  692. <h5>Returns:</h5>
  693. <div class="param-desc">
  694. out
  695. </div>
  696. <dl>
  697. <dt>
  698. Type
  699. </dt>
  700. <dd>
  701. <span class="param-type">mat2d</span>
  702. </dd>
  703. </dl>
  704. <h4 class="name" id=".mul"><span class="type-signature">(static) </span>mul<span class="signature">()</span><span class="type-signature"></span></h4>
  705. <div class="description">
  706. Alias for mat2d.multiply
  707. </div>
  708. <dl class="details">
  709. <dt class="tag-source">Source:</dt>
  710. <dd class="tag-source"><ul class="dummy"><li>
  711. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line442">line 442</a>
  712. </li></ul></dd>
  713. </dl>
  714. <h4 class="name" id=".multiply"><span class="type-signature">(static) </span>multiply<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  715. <div class="description">
  716. Multiplies two mat2d's
  717. </div>
  718. <h5>Parameters:</h5>
  719. <table class="params">
  720. <thead>
  721. <tr>
  722. <th>Name</th>
  723. <th>Type</th>
  724. <th class="last">Description</th>
  725. </tr>
  726. </thead>
  727. <tbody>
  728. <tr>
  729. <td class="name"><code>out</code></td>
  730. <td class="type">
  731. <span class="param-type">mat2d</span>
  732. </td>
  733. <td class="description last">the receiving matrix</td>
  734. </tr>
  735. <tr>
  736. <td class="name"><code>a</code></td>
  737. <td class="type">
  738. <span class="param-type">mat2d</span>
  739. </td>
  740. <td class="description last">the first operand</td>
  741. </tr>
  742. <tr>
  743. <td class="name"><code>b</code></td>
  744. <td class="type">
  745. <span class="param-type">mat2d</span>
  746. </td>
  747. <td class="description last">the second operand</td>
  748. </tr>
  749. </tbody>
  750. </table>
  751. <dl class="details">
  752. <dt class="tag-source">Source:</dt>
  753. <dd class="tag-source"><ul class="dummy"><li>
  754. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line178">line 178</a>
  755. </li></ul></dd>
  756. </dl>
  757. <h5>Returns:</h5>
  758. <div class="param-desc">
  759. out
  760. </div>
  761. <dl>
  762. <dt>
  763. Type
  764. </dt>
  765. <dd>
  766. <span class="param-type">mat2d</span>
  767. </dd>
  768. </dl>
  769. <h4 class="name" id=".multiplyScalar"><span class="type-signature">(static) </span>multiplyScalar<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  770. <div class="description">
  771. Multiply each element of the matrix by a scalar.
  772. </div>
  773. <h5>Parameters:</h5>
  774. <table class="params">
  775. <thead>
  776. <tr>
  777. <th>Name</th>
  778. <th>Type</th>
  779. <th class="last">Description</th>
  780. </tr>
  781. </thead>
  782. <tbody>
  783. <tr>
  784. <td class="name"><code>out</code></td>
  785. <td class="type">
  786. <span class="param-type">mat2d</span>
  787. </td>
  788. <td class="description last">the receiving matrix</td>
  789. </tr>
  790. <tr>
  791. <td class="name"><code>a</code></td>
  792. <td class="type">
  793. <span class="param-type">mat2d</span>
  794. </td>
  795. <td class="description last">the matrix to scale</td>
  796. </tr>
  797. <tr>
  798. <td class="name"><code>b</code></td>
  799. <td class="type">
  800. <span class="param-type">Number</span>
  801. </td>
  802. <td class="description last">amount to scale the matrix's elements by</td>
  803. </tr>
  804. </tbody>
  805. </table>
  806. <dl class="details">
  807. <dt class="tag-source">Source:</dt>
  808. <dd class="tag-source"><ul class="dummy"><li>
  809. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line380">line 380</a>
  810. </li></ul></dd>
  811. </dl>
  812. <h5>Returns:</h5>
  813. <div class="param-desc">
  814. out
  815. </div>
  816. <dl>
  817. <dt>
  818. Type
  819. </dt>
  820. <dd>
  821. <span class="param-type">mat2d</span>
  822. </dd>
  823. </dl>
  824. <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; {mat2d}</span></h4>
  825. <div class="description">
  826. Adds two mat2d's after multiplying each element of the second operand by a scalar value.
  827. </div>
  828. <h5>Parameters:</h5>
  829. <table class="params">
  830. <thead>
  831. <tr>
  832. <th>Name</th>
  833. <th>Type</th>
  834. <th class="last">Description</th>
  835. </tr>
  836. </thead>
  837. <tbody>
  838. <tr>
  839. <td class="name"><code>out</code></td>
  840. <td class="type">
  841. <span class="param-type">mat2d</span>
  842. </td>
  843. <td class="description last">the receiving vector</td>
  844. </tr>
  845. <tr>
  846. <td class="name"><code>a</code></td>
  847. <td class="type">
  848. <span class="param-type">mat2d</span>
  849. </td>
  850. <td class="description last">the first operand</td>
  851. </tr>
  852. <tr>
  853. <td class="name"><code>b</code></td>
  854. <td class="type">
  855. <span class="param-type">mat2d</span>
  856. </td>
  857. <td class="description last">the second operand</td>
  858. </tr>
  859. <tr>
  860. <td class="name"><code>scale</code></td>
  861. <td class="type">
  862. <span class="param-type">Number</span>
  863. </td>
  864. <td class="description last">the amount to scale b's elements by before adding</td>
  865. </tr>
  866. </tbody>
  867. </table>
  868. <dl class="details">
  869. <dt class="tag-source">Source:</dt>
  870. <dd class="tag-source"><ul class="dummy"><li>
  871. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line399">line 399</a>
  872. </li></ul></dd>
  873. </dl>
  874. <h5>Returns:</h5>
  875. <div class="param-desc">
  876. out
  877. </div>
  878. <dl>
  879. <dt>
  880. Type
  881. </dt>
  882. <dd>
  883. <span class="param-type">mat2d</span>
  884. </dd>
  885. </dl>
  886. <h4 class="name" id=".rotate"><span class="type-signature">(static) </span>rotate<span class="signature">(out, a, rad)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  887. <div class="description">
  888. Rotates a mat2d by the given angle
  889. </div>
  890. <h5>Parameters:</h5>
  891. <table class="params">
  892. <thead>
  893. <tr>
  894. <th>Name</th>
  895. <th>Type</th>
  896. <th class="last">Description</th>
  897. </tr>
  898. </thead>
  899. <tbody>
  900. <tr>
  901. <td class="name"><code>out</code></td>
  902. <td class="type">
  903. <span class="param-type">mat2d</span>
  904. </td>
  905. <td class="description last">the receiving matrix</td>
  906. </tr>
  907. <tr>
  908. <td class="name"><code>a</code></td>
  909. <td class="type">
  910. <span class="param-type">mat2d</span>
  911. </td>
  912. <td class="description last">the matrix to rotate</td>
  913. </tr>
  914. <tr>
  915. <td class="name"><code>rad</code></td>
  916. <td class="type">
  917. <span class="param-type">Number</span>
  918. </td>
  919. <td class="description last">the angle to rotate the matrix by</td>
  920. </tr>
  921. </tbody>
  922. </table>
  923. <dl class="details">
  924. <dt class="tag-source">Source:</dt>
  925. <dd class="tag-source"><ul class="dummy"><li>
  926. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line198">line 198</a>
  927. </li></ul></dd>
  928. </dl>
  929. <h5>Returns:</h5>
  930. <div class="param-desc">
  931. out
  932. </div>
  933. <dl>
  934. <dt>
  935. Type
  936. </dt>
  937. <dd>
  938. <span class="param-type">mat2d</span>
  939. </dd>
  940. </dl>
  941. <h4 class="name" id=".scale"><span class="type-signature">(static) </span>scale<span class="signature">(out, a, v)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  942. <div class="description">
  943. Scales the mat2d by the dimensions in the given vec2
  944. </div>
  945. <h5>Parameters:</h5>
  946. <table class="params">
  947. <thead>
  948. <tr>
  949. <th>Name</th>
  950. <th>Type</th>
  951. <th class="last">Description</th>
  952. </tr>
  953. </thead>
  954. <tbody>
  955. <tr>
  956. <td class="name"><code>out</code></td>
  957. <td class="type">
  958. <span class="param-type">mat2d</span>
  959. </td>
  960. <td class="description last">the receiving matrix</td>
  961. </tr>
  962. <tr>
  963. <td class="name"><code>a</code></td>
  964. <td class="type">
  965. <span class="param-type">mat2d</span>
  966. </td>
  967. <td class="description last">the matrix to translate</td>
  968. </tr>
  969. <tr>
  970. <td class="name"><code>v</code></td>
  971. <td class="type">
  972. <span class="param-type">vec2</span>
  973. </td>
  974. <td class="description last">the vec2 to scale the matrix by</td>
  975. </tr>
  976. </tbody>
  977. </table>
  978. <dl class="details">
  979. <dt class="tag-source">Source:</dt>
  980. <dd class="tag-source"><ul class="dummy"><li>
  981. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line219">line 219</a>
  982. </li></ul></dd>
  983. </dl>
  984. <h5>Returns:</h5>
  985. <div class="param-desc">
  986. out
  987. </div>
  988. <dl>
  989. <dt>
  990. Type
  991. </dt>
  992. <dd>
  993. <span class="param-type">mat2d</span>
  994. </dd>
  995. </dl>
  996. <h4 class="name" id=".set"><span class="type-signature">(static) </span>set<span class="signature">(out, a, b, c, d, tx, ty)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  997. <div class="description">
  998. Set the components of a mat2d to the given values
  999. </div>
  1000. <h5>Parameters:</h5>
  1001. <table class="params">
  1002. <thead>
  1003. <tr>
  1004. <th>Name</th>
  1005. <th>Type</th>
  1006. <th class="last">Description</th>
  1007. </tr>
  1008. </thead>
  1009. <tbody>
  1010. <tr>
  1011. <td class="name"><code>out</code></td>
  1012. <td class="type">
  1013. <span class="param-type">mat2d</span>
  1014. </td>
  1015. <td class="description last">the receiving matrix</td>
  1016. </tr>
  1017. <tr>
  1018. <td class="name"><code>a</code></td>
  1019. <td class="type">
  1020. <span class="param-type">Number</span>
  1021. </td>
  1022. <td class="description last">Component A (index 0)</td>
  1023. </tr>
  1024. <tr>
  1025. <td class="name"><code>b</code></td>
  1026. <td class="type">
  1027. <span class="param-type">Number</span>
  1028. </td>
  1029. <td class="description last">Component B (index 1)</td>
  1030. </tr>
  1031. <tr>
  1032. <td class="name"><code>c</code></td>
  1033. <td class="type">
  1034. <span class="param-type">Number</span>
  1035. </td>
  1036. <td class="description last">Component C (index 2)</td>
  1037. </tr>
  1038. <tr>
  1039. <td class="name"><code>d</code></td>
  1040. <td class="type">
  1041. <span class="param-type">Number</span>
  1042. </td>
  1043. <td class="description last">Component D (index 3)</td>
  1044. </tr>
  1045. <tr>
  1046. <td class="name"><code>tx</code></td>
  1047. <td class="type">
  1048. <span class="param-type">Number</span>
  1049. </td>
  1050. <td class="description last">Component TX (index 4)</td>
  1051. </tr>
  1052. <tr>
  1053. <td class="name"><code>ty</code></td>
  1054. <td class="type">
  1055. <span class="param-type">Number</span>
  1056. </td>
  1057. <td class="description last">Component TY (index 5)</td>
  1058. </tr>
  1059. </tbody>
  1060. </table>
  1061. <dl class="details">
  1062. <dt class="tag-source">Source:</dt>
  1063. <dd class="tag-source"><ul class="dummy"><li>
  1064. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line124">line 124</a>
  1065. </li></ul></dd>
  1066. </dl>
  1067. <h5>Returns:</h5>
  1068. <div class="param-desc">
  1069. out
  1070. </div>
  1071. <dl>
  1072. <dt>
  1073. Type
  1074. </dt>
  1075. <dd>
  1076. <span class="param-type">mat2d</span>
  1077. </dd>
  1078. </dl>
  1079. <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>
  1080. <div class="description">
  1081. Returns a string representation of a mat2d
  1082. </div>
  1083. <h5>Parameters:</h5>
  1084. <table class="params">
  1085. <thead>
  1086. <tr>
  1087. <th>Name</th>
  1088. <th>Type</th>
  1089. <th class="last">Description</th>
  1090. </tr>
  1091. </thead>
  1092. <tbody>
  1093. <tr>
  1094. <td class="name"><code>a</code></td>
  1095. <td class="type">
  1096. <span class="param-type">mat2d</span>
  1097. </td>
  1098. <td class="description last">matrix to represent as a string</td>
  1099. </tr>
  1100. </tbody>
  1101. </table>
  1102. <dl class="details">
  1103. <dt class="tag-source">Source:</dt>
  1104. <dd class="tag-source"><ul class="dummy"><li>
  1105. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line321">line 321</a>
  1106. </li></ul></dd>
  1107. </dl>
  1108. <h5>Returns:</h5>
  1109. <div class="param-desc">
  1110. string representation of the matrix
  1111. </div>
  1112. <dl>
  1113. <dt>
  1114. Type
  1115. </dt>
  1116. <dd>
  1117. <span class="param-type">String</span>
  1118. </dd>
  1119. </dl>
  1120. <h4 class="name" id=".sub"><span class="type-signature">(static) </span>sub<span class="signature">()</span><span class="type-signature"></span></h4>
  1121. <div class="description">
  1122. Alias for mat2d.subtract
  1123. </div>
  1124. <dl class="details">
  1125. <dt class="tag-source">Source:</dt>
  1126. <dd class="tag-source"><ul class="dummy"><li>
  1127. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line448">line 448</a>
  1128. </li></ul></dd>
  1129. </dl>
  1130. <h4 class="name" id=".subtract"><span class="type-signature">(static) </span>subtract<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  1131. <div class="description">
  1132. Subtracts matrix b from matrix a
  1133. </div>
  1134. <h5>Parameters:</h5>
  1135. <table class="params">
  1136. <thead>
  1137. <tr>
  1138. <th>Name</th>
  1139. <th>Type</th>
  1140. <th class="last">Description</th>
  1141. </tr>
  1142. </thead>
  1143. <tbody>
  1144. <tr>
  1145. <td class="name"><code>out</code></td>
  1146. <td class="type">
  1147. <span class="param-type">mat2d</span>
  1148. </td>
  1149. <td class="description last">the receiving matrix</td>
  1150. </tr>
  1151. <tr>
  1152. <td class="name"><code>a</code></td>
  1153. <td class="type">
  1154. <span class="param-type">mat2d</span>
  1155. </td>
  1156. <td class="description last">the first operand</td>
  1157. </tr>
  1158. <tr>
  1159. <td class="name"><code>b</code></td>
  1160. <td class="type">
  1161. <span class="param-type">mat2d</span>
  1162. </td>
  1163. <td class="description last">the second operand</td>
  1164. </tr>
  1165. </tbody>
  1166. </table>
  1167. <dl class="details">
  1168. <dt class="tag-source">Source:</dt>
  1169. <dd class="tag-source"><ul class="dummy"><li>
  1170. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line362">line 362</a>
  1171. </li></ul></dd>
  1172. </dl>
  1173. <h5>Returns:</h5>
  1174. <div class="param-desc">
  1175. out
  1176. </div>
  1177. <dl>
  1178. <dt>
  1179. Type
  1180. </dt>
  1181. <dd>
  1182. <span class="param-type">mat2d</span>
  1183. </dd>
  1184. </dl>
  1185. <h4 class="name" id=".translate"><span class="type-signature">(static) </span>translate<span class="signature">(out, a, v)</span><span class="type-signature"> &rarr; {mat2d}</span></h4>
  1186. <div class="description">
  1187. Translates the mat2d by the dimensions in the given vec2
  1188. </div>
  1189. <h5>Parameters:</h5>
  1190. <table class="params">
  1191. <thead>
  1192. <tr>
  1193. <th>Name</th>
  1194. <th>Type</th>
  1195. <th class="last">Description</th>
  1196. </tr>
  1197. </thead>
  1198. <tbody>
  1199. <tr>
  1200. <td class="name"><code>out</code></td>
  1201. <td class="type">
  1202. <span class="param-type">mat2d</span>
  1203. </td>
  1204. <td class="description last">the receiving matrix</td>
  1205. </tr>
  1206. <tr>
  1207. <td class="name"><code>a</code></td>
  1208. <td class="type">
  1209. <span class="param-type">mat2d</span>
  1210. </td>
  1211. <td class="description last">the matrix to translate</td>
  1212. </tr>
  1213. <tr>
  1214. <td class="name"><code>v</code></td>
  1215. <td class="type">
  1216. <span class="param-type">vec2</span>
  1217. </td>
  1218. <td class="description last">the vec2 to translate the matrix by</td>
  1219. </tr>
  1220. </tbody>
  1221. </table>
  1222. <dl class="details">
  1223. <dt class="tag-source">Source:</dt>
  1224. <dd class="tag-source"><ul class="dummy"><li>
  1225. <a href="mat2d.js.html">mat2d.js</a>, <a href="mat2d.js.html#line239">line 239</a>
  1226. </li></ul></dd>
  1227. </dl>
  1228. <h5>Returns:</h5>
  1229. <div class="param-desc">
  1230. out
  1231. </div>
  1232. <dl>
  1233. <dt>
  1234. Type
  1235. </dt>
  1236. <dd>
  1237. <span class="param-type">mat2d</span>
  1238. </dd>
  1239. </dl>
  1240. </article>
  1241. </section>
  1242. </div>
  1243. <nav>
  1244. <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-glMatrix.html">glMatrix</a></li><li><a href="module-mat2.html">mat2</a></li><li><a href="module-mat2d.html">mat2d</a></li><li><a href="module-mat3.html">mat3</a></li><li><a href="module-mat4.html">mat4</a></li><li><a href="module-quat.html">quat</a></li><li><a href="module-quat2.html">quat2</a></li><li><a href="module-vec2.html">vec2</a></li><li><a href="module-vec3.html">vec3</a></li><li><a href="module-vec4.html">vec4</a></li></ul>
  1245. </nav>
  1246. <br class="clear">
  1247. <footer>
  1248. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jul 13 2018 11:51:33 GMT+0200 (W. Europe Daylight Time)
  1249. </footer>
  1250. <script> prettyPrint(); </script>
  1251. <script src="scripts/linenumber.js"> </script>
  1252. </body>
  1253. </html>