module-glMatrix.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Module: glMatrix</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: glMatrix</h1>
  17. <section>
  18. <header>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <div class="description">Common utilities</div>
  23. <dl class="details">
  24. <dt class="tag-source">Source:</dt>
  25. <dd class="tag-source"><ul class="dummy"><li>
  26. <a href="common.js.html">common.js</a>, <a href="common.js.html#line1">line 1</a>
  27. </li></ul></dd>
  28. </dl>
  29. </div>
  30. <h3 class="subsection-title">Methods</h3>
  31. <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>
  32. <div class="description">
  33. Tests whether or not the arguments have approximately the same value, within an absolute
  34. or relative tolerance of glMatrix.EPSILON (an absolute tolerance is used for values less
  35. than or equal to 1.0, and a relative tolerance is used for larger values)
  36. </div>
  37. <h5>Parameters:</h5>
  38. <table class="params">
  39. <thead>
  40. <tr>
  41. <th>Name</th>
  42. <th>Type</th>
  43. <th class="last">Description</th>
  44. </tr>
  45. </thead>
  46. <tbody>
  47. <tr>
  48. <td class="name"><code>a</code></td>
  49. <td class="type">
  50. <span class="param-type">Number</span>
  51. </td>
  52. <td class="description last">The first number to test.</td>
  53. </tr>
  54. <tr>
  55. <td class="name"><code>b</code></td>
  56. <td class="type">
  57. <span class="param-type">Number</span>
  58. </td>
  59. <td class="description last">The second number to test.</td>
  60. </tr>
  61. </tbody>
  62. </table>
  63. <dl class="details">
  64. <dt class="tag-source">Source:</dt>
  65. <dd class="tag-source"><ul class="dummy"><li>
  66. <a href="common.js.html">common.js</a>, <a href="common.js.html#line40">line 40</a>
  67. </li></ul></dd>
  68. </dl>
  69. <h5>Returns:</h5>
  70. <div class="param-desc">
  71. True if the numbers are approximately equal, false otherwise.
  72. </div>
  73. <dl>
  74. <dt>
  75. Type
  76. </dt>
  77. <dd>
  78. <span class="param-type">Boolean</span>
  79. </dd>
  80. </dl>
  81. <h4 class="name" id=".setMatrixArrayType"><span class="type-signature">(static) </span>setMatrixArrayType<span class="signature">(type)</span><span class="type-signature"></span></h4>
  82. <div class="description">
  83. Sets the type of array used when creating new vectors and matrices
  84. </div>
  85. <h5>Parameters:</h5>
  86. <table class="params">
  87. <thead>
  88. <tr>
  89. <th>Name</th>
  90. <th>Type</th>
  91. <th class="last">Description</th>
  92. </tr>
  93. </thead>
  94. <tbody>
  95. <tr>
  96. <td class="name"><code>type</code></td>
  97. <td class="type">
  98. <span class="param-type">Type</span>
  99. </td>
  100. <td class="description last">Array type, such as Float32Array or Array</td>
  101. </tr>
  102. </tbody>
  103. </table>
  104. <dl class="details">
  105. <dt class="tag-source">Source:</dt>
  106. <dd class="tag-source"><ul class="dummy"><li>
  107. <a href="common.js.html">common.js</a>, <a href="common.js.html#line16">line 16</a>
  108. </li></ul></dd>
  109. </dl>
  110. <h4 class="name" id=".toRadian"><span class="type-signature">(static) </span>toRadian<span class="signature">(a)</span><span class="type-signature"></span></h4>
  111. <div class="description">
  112. Convert Degree To Radian
  113. </div>
  114. <h5>Parameters:</h5>
  115. <table class="params">
  116. <thead>
  117. <tr>
  118. <th>Name</th>
  119. <th>Type</th>
  120. <th class="last">Description</th>
  121. </tr>
  122. </thead>
  123. <tbody>
  124. <tr>
  125. <td class="name"><code>a</code></td>
  126. <td class="type">
  127. <span class="param-type">Number</span>
  128. </td>
  129. <td class="description last">Angle in Degrees</td>
  130. </tr>
  131. </tbody>
  132. </table>
  133. <dl class="details">
  134. <dt class="tag-source">Source:</dt>
  135. <dd class="tag-source"><ul class="dummy"><li>
  136. <a href="common.js.html">common.js</a>, <a href="common.js.html#line27">line 27</a>
  137. </li></ul></dd>
  138. </dl>
  139. </article>
  140. </section>
  141. </div>
  142. <nav>
  143. <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>
  144. </nav>
  145. <br class="clear">
  146. <footer>
  147. 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)
  148. </footer>
  149. <script> prettyPrint(); </script>
  150. <script src="scripts/linenumber.js"> </script>
  151. </body>
  152. </html>