Update README.md

This commit is contained in:
Benjamin Kyd
2019-09-09 00:37:54 +01:00
committed by GitHub
parent 925bf86e10
commit 624a91e983

View File

@@ -1,3 +1,78 @@
# Inferno Pathtracer
[![Build Status](https://travis-ci.org/plane000/inferno.png?branch=master)](https://travis-ci.org/plane000/inferno)
![alt text](https://i.imgur.com/POj0JlL.png, "Latest Render")
Inferno is a CPU Only, progressive unidirectional pathtracing engine written in C++.
![Latest Render](https://imgur.com/POj0JlL.png)
### Features
* Supports OBJ Files
* Supports many material properties
* Uses multiple types of acceleration structures
* Fully capable GUI adds much runtime customization to the scene and render settings
* Custom threadpool for best performance
### Installation
```
git clone https://github.com/plane000/inferno
cd inferno
mkdir build
cmake ..
make
```
### Examples
There are many example scenes i have made already !. Just change the CurrentTest variable inside the CMakeList to the name of the file you wish to demo.
### Basic Scene
The basic use of the API is demonstrated below. More documentation will come once the project is more mature.
```cpp
#include "../src/inferno.hpp"
static const int width = 1000;
static const int height = 1000;
int main(int argc, char** argv) {
InfernoEngine inferno;
inferno.SetMode(MODE_OPERATION_PROGRESSIVE_GUI);
inferno.InitWindow(width, height);
Scene* scene = new Scene(width, height);
scene->sky = new SolidColourSky({ 0.0f, 0.0f, 0.0f } 0.0f);
scene->camera = new Camera(width, height);
// Light
Sphere light({ 35.0f, 56.0f, 25.0f }, 35.0f, new Material({ 1.0f, 1.0f, 1.0f }, 0.0f, 5.0f));
scene->objects.push_back(&light);
Sphere sphere({ 0.0f, 0.0f, -8.0f }, 1.0f, new Material({ 0.817f, 0.374, 0.574 }, 0.5f));
scene->objects.push_back(&sphere);
Plane plane({ 0.0f,-1.0f, 0.0f }, { 0.0f, -1.0f, 0.0f }, new Material({ 0.9f, 0.9f, 0.9f }, 0.0f));
scene->objects.push_back(&plane);
inferno.SetScene(scene);
inferno.Ready();
inferno.Render();
return 0;
}
```
![Example Render]()
### Samples
![Stanford Dragon](https://imgur.com/GizuPoI.png)
![Cornell Box No Colours](https://imgur.com/u2sIKxK.png)
![Cornell Box](https://imgur.com/i4hLxra.png)
![Cornell Box Specular Materials](https://imgur.com/wfOieEk.png)
![Stanford Dragon](https://imgur.com/POj0JlL.png)