deploy: b432b81

docs/stdlib/index.html

@@ -3,8 +3,7 @@
 <a href=https://github.com/hexops/mach class=svg-item><img alt=GitHub class=svg-icon src=https://machengine.org//img/github.svg></a>
 <a href=https://discord.gg/XNG3NZgCqp class=svg-item><img alt=Discord class=svg-icon src=https://machengine.org//img/discord.svg></a>
 <a href=https://github.com/sponsors/slimsag class=donate-button><img alt=Heart class=svg-icon src=https://machengine.org//img/heart.svg>
-&nbsp;Donate</a></div></div></div><div id=content><link rel=stylesheet href=https://machengine.org/layouts/docs.b0680784747ebc2f78076427da00de2ab28d57939e19ddbd850b00c59d2f27e0.css><main aria-role=main class=main-docs><aside><ul><li><a href=https://machengine.org/docs><span>Overview</span></a></li><li><a href=https://machengine.org/docs/getting-started><span>Getting started</span></a></li><li><h3><span>Math</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/docs/math>Overview</a></li><li><a href=https://machengine.org/docs/math/coordinate-system>Coordinate system</a></li><li><a href=https://machengine.org/docs/math/traversing-coordinate-systems>Traversing coordinate systems</a></li><li><a href=https://machengine.org/docs/math/matrix-storage>Matrix storage</a></li></ul><li><h3><span>GPU</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/docs/gpu>Overview</a></li><li><a href=https://machengine.org/docs/gpu/memory>Memory management</a></li><li><a href=https://machengine.org/docs/gpu/errors>Error handling</a></li></ul><li><h3><span>General</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/docs/roadmap>Roadmap</a></li><li><a href=https://machengine.org/docs/modularity>Modularity</a></li><li><a href=https://machengine.org/docs/stdlib>Standard library</a></li><li><a href=https://machengine.org/docs/zig-version>Zig version</a></li><li><a href=https://machengine.org/docs/nominated-zig>Nominated Zig</a></li></ul></ul></aside><div class=docs><h1 id=standard-library>Standard library</h1><p>The Mach standard library can be found at: <a href=https://github.com/hexops/mach>github.com/hexops/mach</a> - it is <a href=../modularity>modular by design</a>. Just like the Zig standard library, you can choose which parts to use or not.</p><p>Thanks to Zig&rsquo;s lazy code evaluation and lazy dependency fetching, you really only pay for the parts you use.</p><h2 id=choosing-your-mach-version>Choosing your Mach version</h2><h3 id=04-branch-not-actively-developed-but-more-stable>0.4 branch (not actively developed, but more stable)</h3><p>The 0.4 branch is what applications like <a href=https://github.com/foxnne/pixi>Pixi</a> and games like <code>#lordofzero</code> (in the Discord) are using. It uses GLFW, WebGPU, and optionally the ECS. It is <a href=https://discord.com/channels/996677443681267802/996688886216523907/1259736837648416829>no longer in development</a> however.</p><p>To use this version, add the Mach dependency to your <code>build.zig.zon</code> file:</p><pre><code id=zig-fetch-04>zig fetch --save https://pkg.machengine.org/mach/$LATEST_COMMIT.tar.gz
-</code></pre><script>fetch("https://api.github.com/repos/hexops/mach/branches/0.4",{method:"GET",headers:{Accept:"application/json"}}).then(e=>e.json()).then(e=>{let t=document.querySelector("#zig-fetch-04");t.innerHTML=t.innerHTML.replace("$LATEST_COMMIT",e.commit.sha)})</script><h3 id=main-branch-actively-developed-experimentalunstable>main branch (actively developed, experimental/unstable)</h3><p>This branch is where active development is happening, we are removing GLFW and WebGPU in favor of our own packages (<a href=https://discord.com/channels/996677443681267802/996688886216523907/1259736837648416829>more details</a>) which means it is not stable - or may not even run - on some OS. At the time of writing Sep 30th, Windows is relatively stable, Linux might work under Wayland, and macOS is not expected to work currently.</p><p>To use this version, add the Mach dependency to your <code>build.zig.zon</code> file:</p><pre><code id=zig-fetch-main>zig fetch --save https://pkg.machengine.org/mach/$LATEST_COMMIT.tar.gz
+&nbsp;Donate</a></div></div></div><div id=content><link rel=stylesheet href=https://machengine.org/layouts/docs.b0680784747ebc2f78076427da00de2ab28d57939e19ddbd850b00c59d2f27e0.css><main aria-role=main class=main-docs><aside><ul><li><a href=https://machengine.org/docs><span>Overview</span></a></li><li><a href=https://machengine.org/docs/getting-started><span>Getting started</span></a></li><li><h3><span>Math</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/docs/math>Overview</a></li><li><a href=https://machengine.org/docs/math/coordinate-system>Coordinate system</a></li><li><a href=https://machengine.org/docs/math/traversing-coordinate-systems>Traversing coordinate systems</a></li><li><a href=https://machengine.org/docs/math/matrix-storage>Matrix storage</a></li></ul><li><h3><span>GPU</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/docs/gpu>Overview</a></li><li><a href=https://machengine.org/docs/gpu/memory>Memory management</a></li><li><a href=https://machengine.org/docs/gpu/errors>Error handling</a></li></ul><li><h3><span>General</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/docs/roadmap>Roadmap</a></li><li><a href=https://machengine.org/docs/modularity>Modularity</a></li><li><a href=https://machengine.org/docs/stdlib>Standard library</a></li><li><a href=https://machengine.org/docs/zig-version>Zig version</a></li><li><a href=https://machengine.org/docs/nominated-zig>Nominated Zig</a></li></ul></ul></aside><div class=docs><h1 id=standard-library>Standard library</h1><p>The Mach standard library can be found at: <a href=https://github.com/hexops/mach>github.com/hexops/mach</a> - it is <a href=../modularity>modular by design</a>. Just like the Zig standard library, you can choose which parts to use or not.</p><p>Thanks to Zig&rsquo;s lazy code evaluation and lazy dependency fetching, you really only pay for the parts you use.</p><h2 id=choosing-your-mach-version>Choosing your Mach version</h2><h3 id=04-branch-not-actively-developed-but-more-stable>0.4 branch (not actively developed, but more stable)</h3><p>The 0.4 branch is what applications like <a href=https://github.com/foxnne/pixi>Pixi</a> and games like <code>#lordofzero</code> (in the Discord) are using. It uses GLFW, WebGPU, and optionally the ECS. It is <a href=https://discord.com/channels/996677443681267802/996688886216523907/1259736837648416829>no longer in development</a> however.</p><p>To use this version, see the <a href=https://machengine.org/v0.4/core/getting-started>/v0.4 website mach core getting started guide</a>.</p><h3 id=main-branch-actively-developed-experimentalunstable>main branch (actively developed, experimental/unstable)</h3><p>This branch is where active development is happening, we are removing GLFW and WebGPU in favor of our own packages (<a href=https://discord.com/channels/996677443681267802/996688886216523907/1259736837648416829>more details</a>) which means it is not stable - or may not even run - on some OS. At the time of writing Sep 30th, Windows is relatively stable, Linux might work under Wayland, and macOS is not expected to work currently.</p><p>To use this version, add the Mach dependency to your <code>build.zig.zon</code> file:</p><pre><code id=zig-fetch-main>zig fetch --save https://pkg.machengine.org/mach/$LATEST_COMMIT.tar.gz
 </code></pre><script>fetch("https://api.github.com/repos/hexops/mach/branches/main",{method:"GET",headers:{Accept:"application/json"}}).then(e=>e.json()).then(e=>{let t=document.querySelector("#zig-fetch-main");t.innerHTML=t.innerHTML.replace("$LATEST_COMMIT",e.commit.sha)})</script><h2 id=using-the-dependency>Using the dependency</h2><p>Then make it importable by your code in <code>build.zig</code>, e.g.:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-zig data-lang=zig><span style=display:flex><span><span style=color:#66d9ef>pub</span> <span style=color:#66d9ef>fn</span> build(b<span style=color:#f92672>:</span> <span style=color:#f92672>*</span>std.Build) <span style=color:#66d9ef>void</span> {
 </span></span><span style=display:flex><span>    <span style=color:#75715e>// ...
 </span></span></span><span style=display:flex><span><span style=color:#75715e></span>

v0.4/engine/stdlib/index.html

@@ -6,7 +6,7 @@
 <a href=https://discord.gg/XNG3NZgCqp class=svg-item><img alt=Discord class=svg-icon src=https://machengine.org/v0.4/img/discord.svg></a>
 <a href=https://github.com/sponsors/slimsag class=donate-button><img alt=Heart class=svg-icon src=https://machengine.org/v0.4/img/heart.svg>
 &nbsp;Donate</a></div></div></div><div class=alert><span><strong>You are viewing an old version of Mach (v0.4)</strong> see the <a href=https://machengine.org>latest version here.</a></span></div><div id=content><link rel=stylesheet href=https://machengine.org/v0.4/layouts/docs.1c549ac5e9eaa1dc4997cd957caa9afec046a45d465b64074e1ec4f88737dd7b.css><main aria-role=main class="main-docs with-alert"><aside><ul><li><a href=https://machengine.org/v0.4/engine><span>Engine overview</span></a></li><li><a href=https://machengine.org/v0.4/engine/getting-started><span>Getting started</span></a></li><li><h3><span>Math</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/v0.4/engine/math>Overview</a></li><li><a href=https://machengine.org/v0.4/engine/math/coordinate-system>Coordinate system</a></li><li><a href=https://machengine.org/v0.4/engine/math/traversing-coordinate-systems>Traversing coordinate systems</a></li><li><a href=https://machengine.org/v0.4/engine/math/matrix-storage>Matrix storage</a></li></ul><li><h3><span>GPU</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/v0.4/engine/gpu>Overview</a></li><li><a href=https://machengine.org/v0.4/engine/gpu/memory>Memory management</a></li><li><a href=https://machengine.org/v0.4/engine/gpu/errors>Error handling</a></li></ul><li><h3><span>Engine</span></h3></li><ul class=sub-menu><li><a href=https://machengine.org/v0.4/engine/roadmap>Roadmap</a></li><li><a href=https://machengine.org/v0.4/engine/modularity>Modularity</a></li><li><a href=https://machengine.org/v0.4/engine/stdlib>Standard library</a></li><li><a href=https://machengine.org/v0.4/about/known-issues>Known issues ⮕</a></li></ul></ul></aside><div class=docs><h1 id=standard-library>Standard library</h1><p>The Mach standard library can be found at: <a href=https://github.com/hexops/mach>github.com/hexops/mach</a> - it is <a href=../modularity>modular by design</a>. Just like the Zig standard library, you can choose which parts to use or not.</p><p>Thanks to Zig&rsquo;s lazy code evaluation and lazy dependency fetching, you really only pay for the parts you use.</p><h2 id=getting-started>Getting started</h2><p>Add the Mach dependency to your <code>build.zig.zon</code> file:</p><pre><code id=zig-fetch>zig fetch --save https://pkg.machengine.org/mach/$LATEST_COMMIT.tar.gz
-</code></pre><script>fetch("https://api.github.com/repos/hexops/mach/branches/main",{method:"GET",headers:{Accept:"application/json"}}).then(e=>e.json()).then(e=>{let t=document.querySelector("#zig-fetch");t.innerHTML=t.innerHTML.replace("$LATEST_COMMIT",e.commit.sha)})</script><p>Then make it importable by your code in <code>build.zig</code>, e.g.:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-zig data-lang=zig><span style=display:flex><span><span style=color:#66d9ef>pub</span> <span style=color:#66d9ef>fn</span> build(b<span style=color:#f92672>:</span> <span style=color:#f92672>*</span>std.Build) <span style=color:#66d9ef>void</span> {
+</code></pre><script>fetch("https://api.github.com/repos/hexops/mach/branches/0.4",{method:"GET",headers:{Accept:"application/json"}}).then(e=>e.json()).then(e=>{let t=document.querySelector("#zig-fetch");t.innerHTML=t.innerHTML.replace("$LATEST_COMMIT",e.commit.sha)})</script><p>Then make it importable by your code in <code>build.zig</code>, e.g.:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-zig data-lang=zig><span style=display:flex><span><span style=color:#66d9ef>pub</span> <span style=color:#66d9ef>fn</span> build(b<span style=color:#f92672>:</span> <span style=color:#f92672>*</span>std.Build) <span style=color:#66d9ef>void</span> {
 </span></span><span style=display:flex><span>    <span style=color:#75715e>// ...
 </span></span></span><span style=display:flex><span><span style=color:#75715e></span>
 </span></span><span style=display:flex><span>    <span style=color:#75715e>// Add Mach to our library and executable