README.md 688 Bytes
Newer Older
Georgy Schukin's avatar
Georgy Schukin committed
1
# Mini-Rt
Georgy Schukin's avatar
Georgy Schukin committed
2
Very simple ray tracing library
Georgy Schukin's avatar
Add doc    
Georgy Schukin committed
3
4

![raytracing result](doc/raytracing.jpg)
Georgy Schukin's avatar
Georgy Schukin committed
5

Georgy Schukin's avatar
Georgy Schukin committed
6
## Features
Georgy Schukin's avatar
Georgy Schukin committed
7
8
9
10
11
12
13
14

- Objects: spheres
- Lights: point lights
- Phong shading
- Reflection and refraction (transparency)
- Saving result in JPEG
- Loading scene from file

Georgy Schukin's avatar
Georgy Schukin committed
15
## Installation
Georgy Schukin's avatar
Georgy Schukin committed
16

Georgy Schukin's avatar
Georgy Schukin committed
17
### With CMake
Georgy Schukin's avatar
Georgy Schukin committed
18
19
20
21
22
23
24
25
26
27

```
git clone ...
mkdir mini-rt-build
cd mini-rt-build
cmake ../mini-rt/src
make 
make install
```

Georgy Schukin's avatar
Georgy Schukin committed
28
### With Qt
Georgy Schukin's avatar
Georgy Schukin committed
29
30
31

Just build included Qt project in `src`.

Georgy Schukin's avatar
Georgy Schukin committed
32
## [Documentation](doc/Manual.md)
Georgy Schukin's avatar
Georgy Schukin committed
33

Georgy Schukin's avatar
Georgy Schukin committed
34
## Examples
Georgy Schukin's avatar
Georgy Schukin committed
35

Georgy Schukin's avatar
Georgy Schukin committed
36
Directory `src/test` contains [example program](src/test/minirt_test.cpp) which renders a sample scene or scene from a file.
Georgy Schukin's avatar
Georgy Schukin committed
37

Georgy Schukin's avatar
Georgy Schukin committed
38
Examples of [scene files](doc/Script.md) are in `scenes` directory.
Georgy Schukin's avatar
Georgy Schukin committed
39
40

Enjoy!