miou-zora / zaytracer

Raytracer in Zig

Zaytracer (Raytracer in zig)

📑 Requirements

• 🌸 Nix

Important

You will need to enable nix-command and flakesexperimental features If you get an error about it, consider this command: mkdir -p ~/.config/nix && echo "experimental-features = nix-command flakes" | tee ~/.config/nix/nix.conf

⚡ Usage

🔧 Setup

Clone this repository and run nix develop to enter the development environment

git clone https://github.com/Miou-zora/Zaytracer.git
cd Zaytracer
nix develop

👷 Building

Release

zig build -Doptimize=ReleaseFast
# or
nix build

Debug

zig build

🚀 Running

With zig build or zig build -Doptimize=ReleaseFast

# It will build the project and run it. (do nothing if the project is already built)
zig build run
# or you can run the executable directly
./zig-out/bin/Zaytracer

With nix build

./result/bin/Zaytracer

➕ Using direnv

You may load the devShell automatically using direnv shell integration.

echo "use flake" | tee .envrc
direnv allow

Coding with codespace

If you want to works on the project using codespace, follow these instructions:

I. Create a codespace with current configuration

II. Execute mkdir -p ~/.config/nix && echo "experimental-features = nix-command flakes" | tee ~/.config/nix/nix.conf

III. Execute eval "$(direnv hook bash)" for bash or you can find your hook command here

IV. Execute:

echo "use flake" | tee .envrc
direnv allow

Perf

Performance measures

To take performance measures you can use th perf tool like this:

perf record -g ./Zaytracer
perf report -g 'graph,0.5,caller'

You will need a debug build for that, else you won't have debug symbols.

Time measures

You can use the hyperfine tool to measure the time of execution of the program.

If you use nix build:

hyperfine "./result/bin/Zaytracer" --warmup 10

or if you use zig build -Doptimize=ReleaseFast:

hyperfine "./zig-out/bin/Zaytracer" --warmup 10

zaytracer's Issues

Create `Scene` struct

Create a Scene struct which contains all data used to run raytracing (like shape, light, camera)

`PNG`: use the `PNG` format to render an image.

Currently we can render an image to PPM format but not to PNG. Add the possibility to render an image to PNG format

Add test to `CI`

Add test to CI

Create `pointLight` light

Create pointLight element which contain intensity, color, position and use it in raytracing

`JPEG`: use the `JPEG` format to render an image.

Currently we can render an image to PPM format but not to JPEG. Add the possibility to render an image to JPEG format

Add format check in CI

All is said in the title