diff --git a/README.md b/README.md index 0f0b760..c352581 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@ +# About + +This project is an implementation of an experimental volumetric rendering engine. Using OpenCL this program is able to hardware accelerate Woo's Fast Voxel Traversal Algorithm which traverses through a Sparse Voxel Octree as described by Laine et al. Light is simulated using the Blinn-Phong shading model along with a recursive ray tracer style of shadow tracing. Individual voxels are also textured using a user provided texture atlas and voxel data. + +# Build + In order to build this project you must have Cmake, GLEW, SFML, and the OpenCL development libraries installed / downloaded. You're also going to need OpenCL compatable hardware that supports the cl_khr_gl_sharing extension. The VS2015 build is working, Linux compiles but I don't have hardware that works, and Mac should compile and run, but I don't have access to a Mac. Note on cl_khr_gl_sharing: The cl_khr_gl_sharing extension, or cl_APPLE_gl_sharing for macOS, is only supported on certain hardware. Further, cl_khr_gl_sharing is not supported on intel CPU's running linux. You might be able to install and use beignet to get around this. The program will warn you if your CL device doesn't support this extension. -Featuring... - -* Efficient Sparse Voxel Octrees, Laine et al. -* A fast voxel traversal algorithm for ray tracing, Woo et al. -* Blinn-Phong lighting -* Shadowing -* Textures +# Screenshots Video demo: + [![Video demo](http://img.youtube.com/vi/DHcg2ZKend0/0.jpg)](http://www.youtube.com/watch?v=DHcg2ZKend0) Screenshots: + ![alt tag](https://github.com/MitchellHansen/voxel-raycaster/blob/master/assets/screenshot1.png) ![alt tag](https://github.com/MitchellHansen/voxel-raycaster/blob/master/assets/screenshot.PNG)