clray

view README.rst @ 61:0f174fd60f19

added readme file and license
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 28 Dec 2015 10:27:23 +0200
parents
children d9520da6b801
line source
1 Realtime GPU (OpenCL) polygon mesh raytracer
2 ============================================
4 About
5 -----
6 Clray is an experimental realtime GPU raytracer with OpenCL. It renders polygon
7 mesh scenes loaded from obj files (with minor extensions to the material
8 description format), using a kd-tree constructed with the surface area heuristic
9 (SAH) for ray-test acceleration.
11 If you want to try clray, a few test scenes can be found at:
12 http://nuclear.mutantstargoat.com/sw/clray/clray_test_scenes.tar.gz
14 License
15 -------
16 Copyright (C) John Tsiombikas <nuclear@member.fsf.org>
18 Clray is free software; feel free to use, modify, and/or redistribute it, under
19 the terms of the GNU General Public License version 3, or (at your option) any
20 more recent version published by the Free Software Foundation. See COPYING for
21 details.
23 Material file format extensions
24 -------------------------------
25 Clray will happily read obj/mtl files as exported by most programs. However, the
26 obj material file format does not specify a reflectivity factor. For this reason
27 I've added a custom mtl command named "Nr" to specify reflectivity. Just add it
28 manually to any material you want to make reflective, followed by a number in
29 the range ``[0, 1]``. For instance a reflective red material with white specular
30 highlights could be defined as follows::
32 newmtl mat_red_shiny
33 Ka 1 0 0
34 Kd 1 0 0
35 Ks 0.8 0.8 0.8
36 Ns 80
37 Nr 0.75