README
author Radek Brich <radek.brich@devl.cz>
Mon, 05 May 2008 15:31:14 +0200
branchpyrit
changeset 92 9af5c039b678
parent 66 c5b89d16497a
child 94 4c8abb8977dc
permissions -rw-r--r--
add MSVC compiler support, make it default for Windows new header file simd.h for SSE abstraction and helpers add mselect pseudo instruction for common or(and(...), andnot(...)) replace many SSE intrinsics with new names new MemoryPool class (mempool.h) for faster KdNode allocation remove setMaxDepth() from Octree and KdTree, make max_depth const, it should be defined in constructor and never changed, change after building tree would cause error in traversal modify DefaultSampler to generate nice 2x2 packets of samples for packet tracing optimize Box and BBox::intersect_packet add precomputed invdir attribute to RayPacket scons build system: check for pthread library on Windows check for SDL generate include/config.h with variables detected by scons configuration move auxiliary files to build/ add sanity checks add writable operator[] to Vector

==================
 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 'scons all' to build everything and 'scons -h' for list of targets.

Requirements:
    SCons
    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


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