https://github.com/nhollmann/pathtracer
A simple command line pathtracer.
https://github.com/nhollmann/pathtracer
pathtracer raytracer
Last synced: 11 months ago
JSON representation
A simple command line pathtracer.
- Host: GitHub
- URL: https://github.com/nhollmann/pathtracer
- Owner: NHollmann
- License: mit
- Created: 2019-07-21T23:14:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-17T17:11:05.000Z (almost 7 years ago)
- Last Synced: 2025-03-11T07:33:29.140Z (about 1 year ago)
- Topics: pathtracer, raytracer
- Language: C++
- Homepage:
- Size: 79.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pathtracer
*A simple pathtracer running from the commandline for Linux, macOS and Windows*
This is strongly based on the book [Ray Tracing in a Weekend](http://in1weekend.blogspot.com/2016/01/ray-tracing-in-one-weekend.html) by Peter Shirley.
The code follows the one from the book, but I've changed a lot of the code structure and added some extra features.
## Features
- [x] Runs from the command line with options
- [x] Multithreaded
- [x] PPM Output
- [x] BMP Output
- [x] TGA Output
- [x] Antialiasing
- [x] Diffuse, Metal and Dielectric Materials
- [x] Positionable camera
- [x] Defocus blur
- [x] Motion blur
## Running
The usage is relly simple. For a complete overview of all options, enter `./raytracer --help`. Here are some examples:
```bash
./raytracer --help # Print help with all options
./raytracer # Start raytracing of the default world with default settings
./raytracer --world random # Random Scene (from the book)
./raytracer --world demo # Demo Scene (from the book)
./raytracer --width 1280 --height 640 # Output image with size 1280x640
```
## Requirements
The final binary has no requirements.
To compile this project you need `cmake` >= 3.2 and a C++ compiler with support for C++14. There aren't any other dependencies.
It was tested on Linux (Ubuntu, with gcc), macOS Mojave (clang) and Windows 10 (MSVC).
## Compiling
This project uses cmake for cross platform compilation.
### Unix
Use the default cmake workflow:
```bash
# Assuming you are already in the project directory
mkdir build # Out of source build
cd build
cmake ..
make
./raytracer --help # Show help to check if compilation was successfull.
```
### Windows
Use cmake for windows to create a Visual Studio project.
Open this project and make sure you have Release selected, then compile the complete project.
This was tested with VS 2017.
### Debug build
The project will be builded as Release by default. If you need a debug build, set `CMAKE_BUILD_TYPE` to `Debug`:
```bash
cmake -DCMAKE_BUILD_TYPE=Debug ..
```
### Double precision
To compile the project with doubles instead of floats, set the cmake option `DOUBLE_AS_FLOAT` to `ON`:
```bash
cmake -DDOUBLE_AS_FLOAT ..
```
## Todo
Some features I like to add:
- [ ] More worlds
- [ ] Make drand48 thread safe (maybe erand48?)