Skip to content

README.md

Latest commit

 

History

History
49 lines (37 loc) · 1.87 KB

README.md

File metadata and controls

49 lines (37 loc) · 1.87 KB

README

This is a pathtracer I wrote as my final project for CSE 163 at UCSD. Thank you to professor Ravi for allowing me to publish this publicly. A detailed feature report with sample renders and binaries can be found here.

Dependencies

All of the above libraries are included as headers in the lib folder so you do not have to download them.

Usage

The pathtracer executable has the following CLI interface. Docs for the config file format can be found here and examples in the config directory. Examples of CLI usage can be found in the scripts directory.

./pathtracer {OPTIONS} [scene] [materials] [config] [output]

  pathtracer

OPTIONS:

    -h, --help                        display this help menu
    scene                             the scene file
    materials                         the materials directory
    config                            the config file
    output                            the output file
    "--" can be used to terminate flag options and force all following
    arguments to be treated as positional options

Building

On OS X or Linux run scripts/cmake.sh to create a Makefile project in the build directory. Execute make in the build directory to build the pathtracer and pathtracer_tests executables. GCC 5.4+ is a compatible compiler although recent version of Clang and MSVC should work as well.