MiniRayTracing

KO | EN

gitlite — search

#hacktoberfest #llm #golang #android #rust #linux #docker #nodejs #java #windows #awesome #cli #kubernetes #open-source

(★ 18)

미니 레이 트레이싱

MiniRayTracing Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mini Ray Tracing

This is a simple ray tracer that can be used to render simple scenes.

[Source Code](https://github.com/Skyrich2000/BornToCode/tree/master/minirt)

## Features

* Ray Tracing with Shaders
* Mulit-threaded Ray Tracing
* Anti-aliasing
* Textures (+ Checkerboard)
* Phong Shading (+ Shadows)
* Materials
    * lambertian
    * dielectric (Refraction)
    * metal (Reflection)

![sky-balls](https://raw.githubusercontent.com/Skyrich2000/MiniRayTracing/main/img/sky-balls.png)
![metal-balls](https://raw.githubusercontent.com/Skyrich2000/MiniRayTracing/main/img/metal-balls.png)
![cub3d](https://raw.githubusercontent.com/Skyrich2000/MiniRayTracing/main/img/cub3d.png)
![color-balls](https://raw.githubusercontent.com/Skyrich2000/MiniRayTracing/main/img/color-balls.png)
![room](https://raw.githubusercontent.com/Skyrich2000/MiniRayTracing/main/img/room.png)

## Usage
### Run

> Only works on MacOS

```bash
git clone https://github.com/Skyrich2000/MiniRayTracing
cd MiniRayTracing
./minirt maps/metal-balls.rt
```

### Key Bindings

* WASD,Space,Shift - camera movement
* Mouse L/R - camera rotation, object rotation
* L - toggle light
* M - toggle scatter mode
* T - toggle texture
* R - toggle resolution (**recommended to use this before moving**)
* C - toggle camera
* G - toggle GUI
* P - save to `out.rt` file
* +- - increase/decrease anti-aliasing

### Build

```bash
brew install zlib
git clone https://github.com/Skyrich2000/BornToCode
cd BornToCode/minirt
make
```

### Build Configuration

you can change the default configuration in the [`Makefile`](https://github.com/Skyrich2000/BornToCode/blob/master/minirt/Makefile#L87)

* H_THREAD - number of threads for height (default 5)
* W_THREAD - number of threads for width (default 5)
* LOWER_RESOLUTION - number to lower the resolution level (default 3)
* MAX_DEPTH - maximum depth for raytracing (default 50)

## RT file format
### Scene

| Type | Foramt | Example | Description |
| ---- | ------ | ------- | ----------- |
| Resolution | `R <width> <height>` | `R 800 600` | Can only be declared once |
| Ambient Light | `A <ratio> <r>,<g>,` | `A 0.1 255,255,255` | Can only be declared once |
| Camera | `c <x>,<y>,<z> <rx>,<ry>,<rz> <fov>` | `c 0,0,0 0,0,1 80` | rx,ry,rz is normalized orientation vector |
| Light | `l <x>,<y>,<z> <brightness> <r>,<g>,` | `l 0,0,0 0.1 255,255,255` | |

### Objects

> nx,ny,nz is the normal vector

| Type | Foramt | Example |
| ---- | ------ | ------- |
| Plane | `pl <x>,<y>,<z> <nx>,<ny>,<nz> <r>,<g>,` | `pl 0,0,0 0,1,0 255,255,255` |
| Sphere | `sp <x>,<y>,<z> <r> <r>,<g>,` | `sp 0,0,0 2 255,255,255` |
| Triangle | `tr <x1>,<y1>,<z1> <x2>,<y2>,<z2> <x3>,<y3>,<z3> <r>,<g>,` | `tr 0,0,0 1,0,0 0,0,1 255,255,255` |
| Square | `sq <x>,<y>,<z> <nx>,<ny>,<nz> <side> <r>,<g>,` | `sq 0,0,0 0,1,0 2 255,255,255` |
| Cylinder | `cy <x>,<y>,<z> <nx>,<ny>,<nz> <r> <h> <r>,<g>,` | `cy 0,0,0 0,0,1 2 4 255,255,255` |

### Materials

| Type | Foramt | Example | Description |
| ---- | ------ | ------- | ----------- |
| Lambertian | `<obj>-lambertian ... ` | `sp-lambertian 0,0,0 1 255,255,255` | |
| Metal | `<obj>-metal ... <fuzz>` | `sp-metal 0,0,0 1 255,255,255 0` | 0 becomes like a mirror |
| Dielectric | `<obj>-dielectric ... <ir>` | `sp-dielectric 0,0,0 1 255,255,255 0.9` | |

### Textures

> specified at the end of the line (atfer material)

| Type | Foramt | Example | Description |
| ---- | ------ | ------- | ----------- |
| Checkerboard | `... checkerboard` | `sp 0,0,0 1 0,0,0 checkerboard` | The color is made up of a given color and black |
| Image | `... <path>` | `sp 0,0,0 1 0,0,0 res/earth.png` | Only `*.png` file available |

**Note**: dielectric are not supported for textures

## TODO

* Caustics
* FPS counter
* segfaults

## Reference

https://raytracing.github.io/books/RayTracingInOneWeekend.html

MiniRayTracing

MiniRayTracing Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

MiniRayTracing

MiniRayTracing Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README