Skip to content

Commit

Permalink
core: migrate to the mach standard library
Browse files Browse the repository at this point in the history 
Helps hexops/mach#1165

Signed-off-by: Stephen Gutekanst <[email protected]>
  • Loading branch information
@slimsag
slimsag committed Mar 6, 2024
1 parent 64f2351 commit ebaff07
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 112 deletions.
8 changes: 4 additions & 4 deletions content/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,11 +328,11 @@ a.p-community-icon {
<p style="margin-left: 1rem; display: inline-block; max-width: 35rem;"><a href="/about/goals#zero-fuss-installation">Zero system dependencies</a> to slow you down; only <a href="about/zig-version">zig</a> is needed, we build and package the few relevant dependencies on our own.<br><br>To run on your machine:</small>
</div>
<div>
<pre class="code" tabindex=0 style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh">$ git clone https://github.com/hexops/mach-core
$ cd mach-core/
$ zig build run-textured-cube
<pre class="code" tabindex=0 style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh">$ git clone https://github.com/hexops/mach
$ cd mach/
$ zig build run-core-textured-cube
</code></pre>
<small>Requires <a href="about/zig-version">this Zig nightly version</a> | <a href="/about/known-issues">known issues</a></small>
<small>Requires <a href="about/zig-version">this nominated Zig version</a> | <a href="/about/known-issues">known issues</a></small>
</small>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions content/about/nixos-usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ mkShell {
Then running `zig build` as usual:

```sh
zig build run-textured-cube
zig build run-core-textured-cube
```

## Usage via shell
Expand All @@ -59,7 +59,7 @@ You can also run Mach examples via `steam-run`, for this you will need to instal
env NIXPKGS_ALLOW_UNFREE=1 nix-shell -p steam-run
```

(then `zig build run-textured-cube` as usual)
(then `zig build run-core-textured-cube` as usual)

## Known issues
### Incorrect cursor behavior with cursormode set to disabled
Expand Down
146 changes: 73 additions & 73 deletions content/core/examples.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ pre {
<h1 align="center">Mach core examples</h1>

<small style="margin-top: 0rem; text-align: center;">
All examples require <a href="../../about/zig-version">this Zig nightly version</a> | <a href="/about/known-issues">known issues</a>
All examples require <a href="../../about/zig-version">this nominated Zig version</a> | <a href="/about/known-issues">known issues</a>
</small>

<div class="p-section">
Expand All @@ -84,13 +84,13 @@ pre {
</video>
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/deferred-rendering">deferred-rendering</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/deferred-rendering">deferred-rendering</a></h2>
<p>Dynamic lighting using deferred rendering techniques.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-deferred-rendering
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-deferred-rendering
</pre></code>
</div>
<small>~1300 lines of code</small>
Expand All @@ -99,13 +99,13 @@ zig build run-deferred-rendering

<div class="p-section" id="pbr-basic">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/pbr-basic">pbr-basic</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/pbr-basic">pbr-basic</a></h2>
<p>Physically based rendering (PBR) materials</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-pbr-basic
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-pbr-basic
</pre></code>
</div>
<small>~1000 lines of code</small>
Expand All @@ -124,13 +124,13 @@ zig build run-pbr-basic
</video>
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/gen-texture-light">gen-texture-light</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/gen-texture-light">gen-texture-light</a></h2>
<p>Generates a brick texture at comptime, uses Blinn-Phong lighting, and several pipelines. Move camera with arrow keys / WASD.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-gen-texture-light
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-gen-texture-light
</pre></code>
</div>
<small>~800 lines of code</small>
Expand All @@ -139,13 +139,13 @@ zig build run-gen-texture-light

<div class="p-section" id="procedural-primitives">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/procedural-primitives">procedural-primitives</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/procedural-primitives">procedural-primitives</a></h2>
<p>Procedurally generated geometry, implements a few different shapes (use arrow keys to switch between them.)</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-procedural-primitives
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-procedural-primitives
</pre></code>
</div>
<small>~600 lines of code</small>
Expand All @@ -164,13 +164,13 @@ zig build run-procedural-primitives
</video>
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/pixel-post-process">pixel-post-process</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/pixel-post-process">pixel-post-process</a></h2>
<p>A post-processing effect which pixelates the entire screen.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-pixel-post-process
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-pixel-post-process
</pre></code>
</div>
<small>~500 lines of code</small>
Expand All @@ -179,13 +179,13 @@ zig build run-pixel-post-process

<div class="p-section" id="sprite2d">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/sprite2d">sprite2d</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/sprite2d">sprite2d</a></h2>
<p>Loads a JSON file which describes a spritesheet, and renders sprites to the screen.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-sprite2d
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-sprite2d
</pre></code>
</div>
<small>~400 lines of code</small>
Expand All @@ -202,13 +202,13 @@ zig build run-sprite2d
</video>
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/fractal-cube">fractal-cube</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/fractal-cube">fractal-cube</a></h2>
<p>Cube-inception! Renders the scene to a texture, which is then rendered on the rotating cube itself as a texture!</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-fractal-cube
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-fractal-cube
</pre></code>
</div>
<small>~400 lines of code</small>
Expand All @@ -217,13 +217,13 @@ zig build run-fractal-cube

<div class="p-section" id="cubemap">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/cubemap">cubemap</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/cubemap">cubemap</a></h2>
<p>Renders a cubemap / skybox. Nothing fancy, but these are instrumental as backgrounds in games.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-cubemap
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-cubemap
</pre></code>
</div>
<small>~400 lines of code</small>
Expand All @@ -242,13 +242,13 @@ zig build run-cubemap
</video>
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/textured-cube">textured-cube</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/textured-cube">textured-cube</a></h2>
<p>Loads a PNG image and uploads the texture to the GPU. Renders it on a 3D cube.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-textured-cube
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-textured-cube
</pre></code>
</div>
<small>~300 lines of code</small>
Expand All @@ -257,13 +257,13 @@ zig build run-textured-cube

<div class="p-section" id="image-blur">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/image-blur">image-blur</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/image-blur">image-blur</a></h2>
<p>Leverages a compute shader to blur an image, then renders it. Don't worry if the details are a bit fuzzy!</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-image-blur
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-image-blur
</pre></code>
</div>
<small>~300 lines of code</small>
Expand All @@ -280,13 +280,13 @@ zig build run-image-blur
</video>
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/boids">boids</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/boids">boids</a></h2>
<p>Uses a GPU compute shader to run calculations / simulate flocking behaviour of birds.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-boids
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-boids
</pre></code>
</div>
<small>~300 lines of code</small>
Expand All @@ -295,13 +295,13 @@ zig build run-boids

<div class="p-section" id="two-cubes">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/two-cubes">two-cubes</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/two-cubes">two-cubes</a></h2>
<p>Once you've learned how to render one cube, two is just 30 lines of code more!</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-two-cubes
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-two-cubes
</pre></code>
</div>
<small>~200 lines of code</small>
Expand All @@ -320,13 +320,13 @@ zig build run-two-cubes
</video>
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/instanced-cube">instanced-cube</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/instanced-cube">instanced-cube</a></h2>
<p>EVEN MORE CUBES! Instancing lets you duplicate an object & render it in multiple places with different parameters.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-instanced-cube
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-instanced-cube
</pre></code>
</div>
<small>~200 lines of code</small>
Expand All @@ -335,13 +335,13 @@ zig build run-instanced-cube

<div class="p-section" id="rotating-cube">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/rotating-cube">rotating-cube</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/rotating-cube">rotating-cube</a></h2>
<p>Uploads a basic 3D cube to the GPU and renders it. Demonstrates how to use vertex buffers to transfer a model from the CPU to GPU, how to use vertex attributes & more.</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-rotating-cube
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-rotating-cube
</pre></code>
</div>
<small>~200 lines of code</small>
Expand All @@ -358,13 +358,13 @@ zig build run-rotating-cube
<img src="https://media.machengine.org/core/example/triangle-msaa.png" />
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/triangle-msaa">triangle-msaa</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/triangle-msaa">triangle-msaa</a></h2>
<p>Remember that triangle from before? If we turn on MSAA (Multi-Sample Anti Aliasing) the edges will become <em>smooooth.</em></p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-triangle-msaa
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-triangle-msaa
</pre></code>
</div>
<small>~100 lines of code</small>
Expand All @@ -373,13 +373,13 @@ zig build run-triangle-msaa

<div class="p-section" id="triangle">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/triangle">triangle</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/triangle">triangle</a></h2>
<p>This is where you should start learning. It tells the GPU to render 3 vertices (but doesn't transfer them using a vertex buffer or anything! The vertex positions are hard-coded in the shader.)</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-triangle
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-triangle
</pre></code>
</div>
<small>~100 lines of code</small>
Expand All @@ -394,13 +394,13 @@ zig build run-triangle
<img src="https://media.machengine.org/core/example/map-async.png" />
</a>
<div class="p-section-right">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/map-async">map-async</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/map-async">map-async</a></h2>
<p>Some of the best examples have <em>no graphics</em>. This one shows how to transfer data to the GPU, perform computations on that data using the GPU's parallel processing capabilities, and get results back on the CPU. If you're interested in GPU compute, this is the place to start!</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-map-async
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-map-async
</pre></code>
</div>
<small>~100 lines of code</small>
Expand All @@ -409,13 +409,13 @@ zig build run-map-async

<div class="p-section" id="clear-color">
<div class="p-section-left">
<h2><a href="https://github.com/hexops/mach-core/tree/main/examples/clear-color">clear-color</a></h2>
<h2><a href="https://github.com/hexops/mach/tree/main/src/core/examples/clear-color">clear-color</a></h2>
<p>As simple as it gets: a blue screen of doom</p>
<div>
<code><pre class="code">
git clone https://github.com/hexops/mach-core
cd mach-core/
zig build run-clear-color
git clone https://github.com/hexops/mach
cd mach/
zig build run-core-clear-color
</pre></code>
</div>
<small>~100 lines of code</small>
Expand Down
Loading

0 comments on commit ebaff07

Please sign in to comment.