# rust-raytracer

**Repository Path**: mirrors_ericsink/rust-raytracer

## Basic Information

- **Project Name**: rust-raytracer
- **Description**: Raytracer in Rust.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2026-04-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

rust-raytracer
==============
[![Build Status](https://travis-ci.org/gyng/rust-raytracer.svg?branch=master)](https://travis-ci.org/gyng/rust-raytracer)

![ScreenShot](https://raw.githubusercontent.com/gyng/rust-raytracer/master/docs/sample_render.png)

A raytracer in Rust. Compiles on Rust stable > 1.5.

[Gallery](http://gyng.github.io/rust-raytracer-gallery/) <br>
[Gallery repository](https://github.com/gyng/rust-raytracer-gallery) <br>
[Assets repository](https://github.com/gyng/raytracer-assets)


## Usage

1. Clone the project. `--recursive` clones most sample models and textures into the project directory as well.

        git clone --recursive https://github.com/gyng/rust-raytracer.git

2. Compile

        cargo build --release

3. Edit `sample-config.json` if you wish to render a scene besides the default,
   or if you wish to tweak the renderer parameters

4. Run the compiled program, passing the render configuration as an argument.
   If rendering a provided scene, run the binary in the project root so it can find the models and textures.

        ./main sample-config.json

  or alternatively to compile and run in one single command

        cargo run --release sample-config.json


### Useful commands

* To update (assets) submodules only: `git submodule foreach git pull`
* To convert frames into a video `ffmpeg -i test%06d.ppm -b 2000k out.webm`
* Scenes are created in `./myscene/`. To hook up a scene, add it to `./myscene/mod.rs` and `get_camera_and_scene(&SceneConfig)` in `main.rs`.


## Available Scenes

These should use 30deg fov for squares and 45deg fov for 16:9.

* box
* bunny
* cow
* easing (0s-10s animation)
* fresnel (0s-10s animation)
* lucy
* sibenik (0s-7s animation)
* sphere (0s-10s animation)
* sponza (45deg fov for a square; 67.5deg for 16:9)
* teapot
* heptoroid-white
* heptoroid-shiny
* heptoroid-refractive
* tachikoma


## Features

* Reflections
* Refractions
* Multi-threading
* Soft shadows
* Supersampling
* Cook-Torrance, Phong materials
* Sphere, plane, triangle primitives
* Point, sphere lights
* Unoptimised glossy reflections
* Limited OBJ model and mesh support
* Mesh transformations (4x4 matrices)
* Basic spatial partitioning (octree)
* Basic textures (checker, uv, image)
* Skybox (cubemap)
* Camera animation with Bézier easing


## Missing/potential features

* Scene description
* Caustics/global illumination (progress stalled on `photon-trace` branch)