Home

THIS WIKI IS CURRENTLY ON MAINTENANCE!

---

PearRay is an experimental ray tracing application framework to create photorealistic or artistic single images or animation sequences. It's in active development, but still misses some of the 'required' features to be fully production ready.

See the Road Map for more information about the current status of the project.

Features (Upcoming)

• High quality images based on Spectral Rendering and Multiple Importance Sampling.
• Different integrators. (Distributed Raytracing, Bidirectional Raytracing, Progressive Photon Mapping and VCM( Not implemented ))
• Shaders based on OSL with Displacement Mapping. (TODO)
• Resource Caching
• multi core and GPU-supported rendering.

Resources

• Road Map
• Gallery
• Examples
• Tutorials
• Trello Board

Installing

The PearRay build system uses CMake (>= 2.6) and is buildable on Windows and Linux systems. MacOS is not tested.

Requirements

You need at least the following libraries to compile PearRay from source:

• Boost (>= 1.36)
• OpenImageIO

Following libraries are optional:

• OpenCL (>= 1.1; Optional, but highly recommended!)
• Qt (>= 5.0; Only needed if GUI interface is desired)
• OSL (for shader support)

Compile

• Linux

  Just run cmake and make to compile the source (on the root directory)

    mkdir ./build
    cd ./build
    cmake ../
    make
  

• Windows

  For Windows builds we recommend using CMake GUI and the VisualStudio option.

Available CMake options

Make sure to activate Advanced Options when using CMake GUI

Option	Description	Default
PR_ONLY_LIBRARY	Will only compile the main and utility library.	OFF
PR_NO_GPU	Disables GPU support provided by OpenCL. Will be set automatically to On when OpenCL is not found.	OFF
PR_NO_NETWORK	Disables Network support provided by Boost.	OFF
PR_BUILD_VIEWER	Builds the Qt based PearRay viewer. Will be set automatically to Off when Qt is not found.	ON
PM_USE_SIMD	Use SIMD (min. SSE1 & SSE2) implementation of PearMath, if supported.	ON
PM_FORCE_SSE3	Force SSE3 support even when detection fails.	OFF
PM_FORCE_SSSE3	Force SSSE3 support even when detection fails.	OFF
PM_FORCE_SSE4	Force SSE4 support even when detection fails.	OFF

Run

Just run the PearRay Viewer or the CLI version.

rayview
pearray

For more information about the both interfaces and their command line arguments see their respective pages:

• RayView
• PearRay CLI