Skip to content

Commit

Permalink
Update v4 docs for beta.2
Browse files Browse the repository at this point in the history
  • Loading branch information
toji committed Apr 14, 2024
1 parent df064ad commit 007c2d0
Show file tree
Hide file tree
Showing 33 changed files with 2,828 additions and 1,350 deletions.
28 changes: 14 additions & 14 deletions docs/v4/assets/highlight.css
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
:root {
--light-hl-0: #000000;
--dark-hl-0: #D4D4D4;
--light-hl-1: #098658;
--dark-hl-1: #B5CEA8;
--light-hl-2: #795E26;
--dark-hl-2: #DCDCAA;
--light-hl-3: #001080;
--dark-hl-3: #9CDCFE;
--light-hl-4: #0000FF;
--dark-hl-4: #569CD6;
--light-hl-5: #AF00DB;
--dark-hl-5: #C586C0;
--light-hl-6: #A31515;
--dark-hl-6: #CE9178;
--light-hl-0: #AF00DB;
--dark-hl-0: #C586C0;
--light-hl-1: #000000;
--dark-hl-1: #D4D4D4;
--light-hl-2: #001080;
--dark-hl-2: #9CDCFE;
--light-hl-3: #A31515;
--dark-hl-3: #CE9178;
--light-hl-4: #098658;
--dark-hl-4: #B5CEA8;
--light-hl-5: #795E26;
--dark-hl-5: #DCDCAA;
--light-hl-6: #0000FF;
--dark-hl-6: #569CD6;
--light-hl-7: #008000;
--dark-hl-7: #6A9955;
--light-code-background: #FFFFFF;
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/assets/search.js

Large diffs are not rendered by default.

293 changes: 206 additions & 87 deletions docs/v4/classes/Mat2.html

Large diffs are not rendered by default.

287 changes: 203 additions & 84 deletions docs/v4/classes/Mat2d.html

Large diffs are not rendered by default.

335 changes: 241 additions & 94 deletions docs/v4/classes/Mat3.html

Large diffs are not rendered by default.

532 changes: 393 additions & 139 deletions docs/v4/classes/Mat4.html

Large diffs are not rendered by default.

343 changes: 233 additions & 110 deletions docs/v4/classes/Quat.html

Large diffs are not rendered by default.

299 changes: 209 additions & 90 deletions docs/v4/classes/Quat2.html

Large diffs are not rendered by default.

407 changes: 283 additions & 124 deletions docs/v4/classes/Vec2.html

Large diffs are not rendered by default.

421 changes: 290 additions & 131 deletions docs/v4/classes/Vec3.html

Large diffs are not rendered by default.

411 changes: 285 additions & 126 deletions docs/v4/classes/Vec4.html

Large diffs are not rendered by default.

25 changes: 13 additions & 12 deletions docs/v4/functions/EnableSwizzles.html

Large diffs are not rendered by default.

37 changes: 27 additions & 10 deletions docs/v4/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,22 @@ <h2>Fast, flexible vector and matrix math for JavaScript</h2>
<p><a href="https://www.npmjs.com/package/gl-matrix"><img src="https://img.shields.io/npm/v/gl-matrix.svg" alt="NPM Version"></a>
<a href="https://travis-ci.org/toji/gl-matrix"><img src="https://travis-ci.org/toji/gl-matrix.svg" alt="Build Status"></a></p>
<p>glMatrix is a high performance, very flexible library for vector and matrix operations in JavaScript/TypeScript, designed for the needs of realtime 3D graphics APIs like WebGL and WebGPU.</p>

<a href="#docs" id="docs" style="color: inherit; text-decoration: none;">
<h2>Docs</h2>
</a>
<p>Documentation is available at <a href="https://glmatrix.net/docs/v4/">https://glmatrix.net/docs/v4/</a></p>

<a href="#using-float64array" id="using-float64array" style="color: inherit; text-decoration: none;">
<h2>Using Float64Array</h2>
</a>
<p>If your use case requires additional precision beyond the default 32-bit floats used by default, you can instead use a 64-bit verions of the library by importing from the <code>f64/</code> directory of your chosen build type. For example:</p>
<pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">Vec3</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;./gl-matrix/dist/esm/f64/vec3.js&#39;</span><span class="hl-1">;</span>
</code></pre>
<p>If you have a need to mix and match the 64 bit and 32 bit versions, you can do so by importing them as different names:</p>
<pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">Vec3</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1"> </span><span class="hl-2">Vec3F32</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;./gl-matrix/dist/esm/vec3.js&#39;</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">Vec3</span><span class="hl-1"> </span><span class="hl-0">as</span><span class="hl-1"> </span><span class="hl-2">Vec3F64</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;./gl-matrix/dist/esm/f64/vec3.js&#39;</span><span class="hl-1">;</span>
</code></pre>
<p>All API calls are identical between the two versions, the only difference is the type of TypedArray which the classes extend.</p>
</div></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/toji/gl-matrix" target="_blank">GitHub Repo</a></nav>
Expand All @@ -44,34 +60,35 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<ul></ul></li></ul></div></details></nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul>
<li class="tsd-kind-type-alias"><a href="types/Mat2Like.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Mat2<wbr/>Like</a></li>
<li class="tsd-kind-type-alias"><a href="types/FloatArray.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Float<wbr/>Array</a></li>
<li class="tsd-kind-type-alias"><a href="types/Mat2Like.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Mat2<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Mat2.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Mat2</a></li>
<li class="tsd-kind-type-alias"><a href="types/mat2-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>mat2</a></li>
<li class="tsd-kind-variable"><a href="variables/mat2-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>mat2</a></li>
<li class="tsd-kind-type-alias"><a href="types/Mat2dLike.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Mat2d<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Mat2d.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Mat2d</a></li>
<li class="tsd-kind-type-alias"><a href="types/mat2d-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>mat2d</a></li>
<li class="tsd-kind-variable"><a href="variables/mat2d-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>mat2d</a></li>
<li class="tsd-kind-type-alias"><a href="types/Mat3Like.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Mat3<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Mat3.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Mat3</a></li>
<li class="tsd-kind-type-alias"><a href="types/mat3-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>mat3</a></li>
<li class="tsd-kind-variable"><a href="variables/mat3-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>mat3</a></li>
<li class="tsd-kind-type-alias"><a href="types/Mat4Like.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Mat4<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Mat4.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Mat4</a></li>
<li class="tsd-kind-type-alias"><a href="types/mat4-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>mat4</a></li>
<li class="tsd-kind-variable"><a href="variables/mat4-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>mat4</a></li>
<li class="tsd-kind-type-alias"><a href="types/QuatLike.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Quat<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Quat.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Quat</a></li>
<li class="tsd-kind-type-alias"><a href="types/quat-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>quat</a></li>
<li class="tsd-kind-variable"><a href="variables/quat-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>quat</a></li>
<li class="tsd-kind-type-alias"><a href="types/Quat2Like.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Quat2<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Quat2.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Quat2</a></li>
<li class="tsd-kind-type-alias"><a href="types/quat2-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>quat2</a></li>
<li class="tsd-kind-variable"><a href="variables/quat2-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>quat2</a></li>
<li class="tsd-kind-function"><a href="functions/EnableSwizzles.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>Enable<wbr/>Swizzles</a></li>
<li class="tsd-kind-type-alias"><a href="types/Vec2Like.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Vec2<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Vec2.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Vec2</a></li>
<li class="tsd-kind-type-alias"><a href="types/vec2-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>vec2</a></li>
<li class="tsd-kind-variable"><a href="variables/vec2-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>vec2</a></li>
<li class="tsd-kind-type-alias"><a href="types/Vec3Like.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Vec3<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Vec3.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Vec3</a></li>
<li class="tsd-kind-type-alias"><a href="types/vec3-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>vec3</a></li>
<li class="tsd-kind-variable"><a href="variables/vec3-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>vec3</a></li>
<li class="tsd-kind-type-alias"><a href="types/Vec4Like.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Vec4<wbr/>Like</a></li>
<li class="tsd-kind-class"><a href="classes/Vec4.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Vec4</a></li>
<li class="tsd-kind-type-alias"><a href="types/vec4-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>vec4</a></li></ul></nav></div></div>
<li class="tsd-kind-variable"><a href="variables/vec4-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>vec4</a></li></ul></nav></div></div>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div><script src="assets/main.js"></script></body></html>
Loading

0 comments on commit 007c2d0

Please sign in to comment.