ruevs / jartsy

Just Another Ray Tracing System - not really for now :-)

JARTSy

This repository contains the source code of JARTSy, which may or may not become a half decent ray tracing program :-)

What is This

This is "homework" for the Chaos Camp Ray Tracing Course 2022.

Example Usage

Render myscene.jrts into myscene.ppm in 1024x768 resolution. Render myscene.jrts into myscene.png in 1024x768 resolution.

jartsy render -o %%.ppm --size 1024x768 myscene.jrts
jartsy render -o %%.png --size 1024x768 myscene.jrts

Building on Linux

You will need the usual build tools, CMake. On a Debian derivative (e.g. Ubuntu) these can be installed with:

sudo apt install git build-essential cmake

On a RedHat derivative (e.g. Fedora) the dependencies can be installed with:

sudo dnf install git gcc-c++ cmake

Before building, check out the project and the necessary submodules:

git clone https://github.com/ruevs/jartsy
cd jartsy
git submodule update --init

After that, build JARTSy like this:

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DENABLE_OPENMP=ON
make

Link Time Optimization is supported by adding -DENABLE_LTO=ON to cmake at the expense of longer build time.

Building on macOS

You will need git, XCode tools, CMake and libomp. Git, CMake and libomp can be installed via Homebrew:

brew install git cmake libomp

XCode has to be installed via AppStore or the Apple website; it requires a free Apple ID.

Before building, check out the project and the necessary submodules:

git clone https://github.com/ruevs/jartsy
cd jartsy
git submodule update --init

After that, build JARTSy like this:

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DENABLE_OPENMP=ON
make

Link Time Optimization is supported by adding -DENABLE_LTO=ON to cmake at the expense of longer build time.

Alternatively, generate an XCode project, open it, and build the "Release" scheme:

mkdir build
cd build
cmake .. -G Xcode

Building on Windows

You will need git, cmake and a C++ compiler (either Visual C++ or MinGW). If using Visual C++, Visual Studio 2015 or later is required.

Check Out the Project

git clone https://github.com/ruevs/jartsy
cd jartsy
rem submodule update --init

Building with Visual Studio IDE

Create a directory build in the source tree and point cmake-gui to the source tree and that directory. Press "Configure" and "Generate", then open build\jartsy.sln with Visual C++ and build it.

Or simply use the CMake support integrated in modern Visual Studio by choosing File | Open | Folder... and hitting F7.

Building with Visual Studio in a command prompt

First, ensure that git and cl (the Visual C++ compiler driver) are in your %PATH%; the latter is usually done by invoking vcvarsall.bat from your Visual Studio install. Then, run the following in cmd or PowerShell:

mkdir build
cd build
cmake .. -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release
nmake

Building with MinGW

It is also possible to build JARTSy using MinGW.

First, ensure that git and gcc are in your $PATH. Then, run the following in bash:

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make

License

JARTSy is distributed under the terms of the GPL v3 or later.