README
author Radek Brich <radek.brich@devl.cz>
Wed, 26 Mar 2008 00:52:27 +0100
branchpyrit
changeset 46 6493fb65f0b1
parent 44 3763b26244f0
child 66 c5b89d16497a
permissions -rw-r--r--
Doxygen new Sampler object replacing rendering algorithm with more flexible one -- this breaks most of demos and disables threads and (over-/sub-)sampling functionality, need a rewrote

==================
 Pyrit Ray Tracer
==================


File Organization
-----------------
/bin      -- output directory for binary objects
/ccdemos  -- ray tracer demos in C++
/demos    -- ray tracer demos in Python
/include  -- header files
/models   -- common models for use by demos
/src      -- ray tracing library source code
/tests    -- test programs for classes

Classes organization throughout header files is explained in DEVNOTES.


Building
--------
Type 'make all' to build everything and 'make help' for list of targets.

Requirements:
    pthreads (see bellow)
    Python 2.4 or newer for Python module and demos
    PIL (Python Imaging Library) for Python demos
    SDL for interactive C++ demos
    libpng and zlib for rendering to PNG file from C++ demos

Flags can be adjusted in config.mk.


Pthreads
--------
Threads can be used to render rows of picture paralelly. Arbitrary number
of threads can be used, even numbers like 17 are acceptable.

To completely disable this feature just remove "-DPTHREADS -pthreads"
from flags in makefile.

For Windows + Mingw32, get pthreads library here:
http://sources.redhat.com/pthreads-win32/


License
-------
This software is published under terms of MIT license.
See COPYING for full text of license.


Website
-------
Latest version can be obtained at http://wiki.fiction.cz/Pyrit