fix readme
This commit is contained in:
parent
8d2af1dbda
commit
c89dda21e2
61
README.md
61
README.md
@ -1,16 +1,12 @@
|
|||||||
# GPU Ray Tracer
|
# GPU Compute Engine
|
||||||
GPU Ray Tracing application based on my OpenGL Compute Engine.
|
GPU Compute Engine library used to run compute shaders on the GPU and show results in a window.
|
||||||
<p align="center">
|
|
||||||
<img src="screenshots/fox2.png">
|
|
||||||
</p>
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
* OpenGL
|
* OpenGL
|
||||||
* GLFW
|
* GLFW
|
||||||
* GLEW
|
* GLEW
|
||||||
* [stb_image](https://github.com/nothings/stb)
|
* [stb_image](https://github.com/nothings/stb)
|
||||||
* [OpenGL Compute Engine](https://github.com/DawidPietrykowski/ComputeEngine)
|
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
@ -18,60 +14,9 @@ Specify these root directories for dependencies in [make.bat](make.bat) script:
|
|||||||
* GLFW_ROOT
|
* GLFW_ROOT
|
||||||
* GLEW_ROOT
|
* GLEW_ROOT
|
||||||
* stb_image_ROOT
|
* stb_image_ROOT
|
||||||
* ComputeEngine_ROOT
|
|
||||||
|
|
||||||
Run [make.bat](make.bat) script.
|
Run [make.bat](make.bat) script.
|
||||||
|
|
||||||
## Config files
|
|
||||||
|
|
||||||
Each scene/configuration is described in a config file.
|
|
||||||
|
|
||||||
Example scenes are located in [/configs](configs) directory.
|
|
||||||
|
|
||||||
All available parameters are specified in [config_template.txt](config_template.txt).
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Pass chosen config file to the generated executable as an argument in command line.
|
|
||||||
|
|
||||||
If no argument given, *config.txt* is picked.
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
* Wavefront (.obj) file import
|
|
||||||
* PNG, JPG, HDR texture import
|
|
||||||
* Object can be an imported triangle mesh, sphere or infinite plane
|
|
||||||
* Each scene is saved in a separate file
|
|
||||||
* Specular and diffuse reflections
|
|
||||||
* Physics based refractions
|
|
||||||
* Camera movement
|
|
||||||
* Screenshot saving
|
|
||||||
|
|
||||||
## Example images
|
|
||||||
Mesh | Refraction
|
|
||||||
:-------------------------:|:-------------------------:
|
|
||||||
![](screenshots/fox2.png) | ![](screenshots/refraction1.png)
|
|
||||||
Multiple meshes 1 | Multiple meshes 2
|
|
||||||
![](screenshots/objects1.png) | ![](screenshots/objects4.jpg)
|
|
||||||
Solar system 1 | Solar system 2
|
|
||||||
![](screenshots/solar_system1.png) | ![](screenshots/solar_system2.png)
|
|
||||||
|
|
||||||
## Keys
|
|
||||||
Camera
|
|
||||||
|
|
||||||
* UP - SPACE
|
|
||||||
* DOWN - CTRL
|
|
||||||
* LEFT - A
|
|
||||||
* RIGHT - D
|
|
||||||
* FORWARD - W
|
|
||||||
* BACKWARD - S
|
|
||||||
|
|
||||||
Window
|
|
||||||
|
|
||||||
* Screenshot - L
|
|
||||||
* Disable input to window - P
|
|
||||||
* Close application - ESC
|
|
||||||
|
|
||||||
## License and copyright
|
## License and copyright
|
||||||
|
|
||||||
© Dawid Pietrykowski
|
© Dawid Pietrykowski
|
||||||
|
Loading…
Reference in New Issue
Block a user