# Intel® Open Path Guiding Library This is release v0.7.1 of Intel® Open PGL. For changes and new features, see the [changelog](CHANGELOG.md). Visit http://www.openpgl.org for more information. # Overview The Intel® Open Path Guiding Library (Intel® Open PGL) implements a set of representations and training algorithms needed to integrate path guiding into a renderer. Open PGL offers implementations of current state-of-the-art path guiding methods, which increase the sampling quality and, therefore, the efficiency of a renderer. The goal of Open PGL is to provide implementations that are well tested and robust enough to be used in a production environment. The representation of the guiding field is learned during rendering and updated on a per-frame basis using radiance/importance samples generated during rendering. At each vertex of a random path/walk, the guiding field is queried for a local distribution (e.g., incident radiance), guiding local sampling decisions (e.g., directions). Currently supported path guiding methods include: guiding directional sampling decisions on surfaces and inside volumes based on a learned incident radiance distribution or its product with BSDF components (i.e., cosine lobe) or phase functions (i.e., single lobe HG). Open PGL offers a C API and a C++ wrapper API for higher-level abstraction. The current implementation is optimized for the latest Intel® processors with support for SSE, AVX, AVX2, and AVX-512 instructions. Open PGL is part of the [Intel® oneAPI Rendering Toolkit](https://software.intel.com/en-us/rendering-framework) and has been released under the permissive [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0). | ![Example rendering without and with Open PGL](/doc/images/example.png) | |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | Path traced image of a variation of the Nishita Sky Demo scene from Blender Studio (CC0) without and with using Open PGL to guide directional samples (i.e., on surfaces and inside the water volume). | # Disclaimer The current version of Open PGL is still in a pre v1.0 stage and should be used with caution in any production related environment. The API specification is still in flux and might change with upcoming releases. # Latest Updates The full version history can be found [here](./CHANGELOG.md) ## Open PGL 0.7.1 - Bugfixes: - Fixing invalidation of the guiding field on initial creation if a cell contains no samples [\#23](https://github.com/RenderKit/openpgl/issues/23). - Fixing noisy stdout printouts [\#19](https://github.com/RenderKit/openpgl/issues/19). - Improving robustness of the integer arithmetric used during the deterministic multi-threaded building of the spatial subdivision structure. - Improving numerical stability of fitting process of the VMM-based guiding models. # Support and Contact Open PGL is under active development. Though we do our best to guarantee stable release versions, a certain number of bugs, as-yet-missing features, inconsistencies, or any other issues are still possible. Should you find any such issues, please report them immediately via [Open PGL’s GitHub Issue Tracker](https://github.com/OpenPathGuidingLibrary/openpgl/issues) (or, if you should happen to have a fix for it, you can also send us a pull request). # Reference ``` code @misc{openpgl, Author = {Herholz, Sebastian and Dittebrandt, Addis}, Year = {2022}, Note = {http://www.openpgl.org}, Title = {Intel{\textsuperscript{\tiny\textregistered}} Open Path Guiding Library} } ``` # Building Open PGL from source The latest Open PGL sources are always available at the [Open PGL GitHub repository](https://github.com/RenderKit/openpgl). The default `main` branch should always point to the latest tested bugfix release. ## Prerequisites Open PGL currently supports Linux, Windows and MacOS. In addition, before building Open PGL you need the following prerequisites: - You can clone the latest Open PGL sources via: git clone https://github.com/RenderKit/openpgl.git - To build Open PGL you need [CMake](http://www.cmake.org), any form of C++11 compiler (we recommend using GCC, but also support Clang and MSVC), and standard Linux development tools. - Open PGL depends on TBB, which is available at the [TBB GitHub repository](https://github.com/oneapi-src/oneTBB). - Open PGL depends on OIDN, if the **Image-space Guiding Buffer** feature is enabled, which is available at the [OIDN GitHub repository](https://github.com/RenderKit/oidn). Depending on your Linux distribution, you can install these dependencies using `yum` or `apt-get`. Some of these packages might already be installed or might have slightly different names. ## CMake Superbuild For convenience, Open PGL provides a CMake Superbuild script which will pull down Open PGL’s dependencies and build Open PGL itself. The result is an install directory including all dependencies. Run with: ``` bash mkdir build cd build cmake ../superbuild cmake --build . ``` The resulting `install` directory (or the one set with `CMAKE_INSTALL_PREFIX`) will have everything in it, with one subdirectory per dependency. CMake options to note (all have sensible defaults): - `CMAKE_INSTALL_PREFIX`: The root directory where everything gets installed to. - `BUILD_JOBS`: Sets the number given to `make -j` for parallel builds. - `BUILD_STATIC`: Builds Open PGL as static library (default `OFF`). - `BUILD_TOOLS`: Builds Open PGL’s tools (default `OFF`). - `BUILD_DEPENDENCIES_ONLY`: Only builds Open PGL’s dependencies (default `OFF`). - `BUILD_TBB`: Builds or downloads TBB (default `ON`). - `BUILD_TBB_FROM_SOURCE`: Specifies whether TBB should be built from source or the releases on GitHub should be used. This must be ON when compiling for ARM (default `OFF`). - `BUILD_OIDN`: Builds or downloads Intel’s Open Image Denoise (OIDN) (default `ON`). - `BUILD_OIDN_FROM_SOURCE`: Builds OIDN from source. This must be ON when compiling for ARM. (default `ON`). - `DOWNLOAD_ISPC`: Downloads Intel’s ISPC compiler which is needed to build OIDN (default `ON` when building OIDN from source). For the full set of options, run `ccmake [/superbuild]`. ## Standard CMake build Assuming the above prerequisites are all fulfilled, building Open PGL through CMake is easy: Create a build directory, and go into it: ``` bash mkdir build cd build ``` Configure the Open PGL build using: ``` bash cmake -DCMAKE_INSTALL_PREFIX=[openpgl_install] .. ``` - CMake options to note (all have sensible defaults): - `CMAKE_INSTALL_PREFIX`: The root directory where everything gets installed to. - `OPENPGL_BUILD_STATIC`: Builds Open PGL as a static or shared library (default `OFF`). - `OPENPGL_ISA_AVX512`: Compiles Open PGL with AVX-512 support (default `OFF`). - `OPENPGL_ISA_NEON` and `OPENPGL_ISA_NEON2X`: Compiles Open PGL with NEON or double pumped NEON support (default `OFF`). - `OPENPGL_LIBRARY_NAME`: Specifies the name of the Open PGL library file created. By default the name `openpgl` is used. - `OPENPGL_BUILD_STATIC`: Builds Open PGL as static library (default `OFF`). - `OPENPGL_BUILD_TOOLS`: Builds additional tools such as: `openpgl_bench` and `openpgl_debug` for benchmarking and debuging guiding caches (default `OFF`). - `OPENPGL_EF_RADIANCE_CACHES`: Enables the **experimental** radiance caching feature (default `OFF`). - `OPENPGL_EF_IMAGE_SPACE_GUIDING_BUFFER`: Enables the **experimental** image-space guiding buffer feature (default `OFF`). - `OPENPGL_DIRECTION_COMPRESSION`: Enables the 32Bit compression for directional data stored in `pgl_direction` (default `OFF`). - `OPENPGL_RADIANCE_COMPRESSION`: Enables the 32Bit compression for RGB data stored in `pgl_spectrum` (default `OFF`). - `OPENPGL_TBB_ROOT`: Location of the TBB installation. - `OPENPGL_TBB_COMPONENT`: The name of the TBB component/library (default `tbb`). Build and install Open PGL using: ``` bash cmake build cmake install ``` # Including Open PGL into a project ## Including into CMake build scripts. To include Open PGL into a project which is using CMake as a build system, one can simply use the CMake configuration files provided by Open PGL. To make CMake aware of Open PGL’s CMake configuration scripts the `openpgl_DIR` has to be set to their location during configuration: ``` bash cmake -Dopenpgl_DIR=[openpgl_install]/lib/cmake/openpgl-0.7.1 .. ``` After that, adding OpenPGL to a CMake project/target is done by first finding Open PGL using `find_package()` and then adding the `openpgl:openpgl` targets to the project/target: ``` cmake # locating Open PGL library and headers find_package(openpgl REQUIRED) # setting up project/target ... add_executable(myProject ...) ... # adding Open PGL to the project/target target_include_directories(myProject openpgl::openpgl) target_link_libraries(myProject openpgl::openpgl) ``` ## Including Open PGL API headers Open PGL offers two types of APIs. The C API is C99 conform and is the basis for interacting with Open PGL. To use the C API of Open PGL, one only needs to include the following header: ``` c #include ``` The C++ API is a header-based wrapper of the C API, which offers a more comfortable, object-oriented way of using Open PGL. To use the C++ API of Open PGL, one only needs to include the following header: ``` c++ #include ``` # Open PGL API The API specification of Open PGL is currently still in a “work in progress” stage and might change with the next releases - depending on the community feedback and library evolution. We, therefore, only give here a small overview of the C++ class structures and refer to the individual class header files for detailed information. ## Device ``` c++ #include ``` The `Device` class is a key component of OpenPGL. It defines the backend used by Open PGL. OpenPGL supports different CPU backends using SSE, AVX, or AVX-512 optimizations. Note: support for different GPU backends is planned in future releases. ## Field ``` c++ #include ``` The `Field` class is a key component of Open PGL. An instance of this class holds the spatio-directional guiding information (e.g., approximation of the incoming radiance field) for a scene. The `Field` is responsible for storing, learning, and accessing the guiding information. This information can be the incidence radiance field learned from several training iterations across the whole scene. The `Field` holds separate approximations for surface and volumetric radiance distributions, which can be accessed separately. The representation of a scene’s radiance distribution is usually separated into a positional and directional representation using a spatial subdivision structure. Each spatial leaf node (a.k.a. Region) contains a directional representation for the local incident radiance distribution. ## SurfaceSamplingDistribution ``` c++ #include ``` The `SurfaceSamplingDistribution` class represents the guiding distribution used for sampling directions on surfaces. The sampling distribution is often proportional to the incoming radiance distribution or its product with components of a BSDF model (e.g., cosine term). The class supports functions for sampling and PDF evaluations. ## VolumeSamplingDistribution ``` c++ #include ``` The `VolumeSamplingDistribution` class represents the guiding distribution used for sampling directions inside volumes. The sampling distribution is often proportional to the incoming radiance distribution or its product with the phase function (e.g., single lobe HG). The class supports functions for sampling and PDF evaluations. ## SampleData ``` c++ #include ``` The `SampleData` struct represents a radiance sample (e.g., position, direction, value). Radiance samples are generated during rendering and are used to train/update the guiding field (e.g., after each rendering progression). A `SampleData` object is created at each vertex of a random walk/path. To collect the data at a specific vertex, the whole path (from its endpoint to the current vertex) must be considered, and information (e.g., radiance) must be backpropagated. ## SampleStorage ``` c++ #include ``` The `SampleStorage` class is a storage container collecting all SampleData generated during rendering. It stores the (radiance/photon) samples generated during rendering. The implementation is thread save and supports concurrent adding of samples from multiple threads. As a result, only one instance of this container is needed per rendering process. The stored samples are later used by the Field class to train/learn the guiding field (i.e., radiance field) for a scene. ## PathSegmentStorage ``` c++ #include ``` The `PathSegmentStorage` is a utility class to help generate multiple `SampleData` objects during the path/random walk generation process. For the construction of a path/walk, each new `PathSegment` is stored in the `PathSegmentStorage`. When the walk is finished or terminated, the -radiance- SampleData is generated using a backpropagation process. The resulting samples are then be passed to the global `SampleDataStorage`. Note: The `PathSegmentStorage` is just a utility class meaning its usage is not required. It is possible to for the users to use their own method for generating `SampleData` objects during rendering. ## PathSegment ``` c++ #include ``` The `PathSegment` struct stores all required information for a path segment (e.g., position, direction, PDF, BSDF evaluation). A list of succeeding segments (stored in a `PathSegmentStorage`) is used to generate `SampleData` for training the guiding field. # Projects that make use of Open PGL TBA # Projects that are closely related to Open PGL - The [Intel® oneAPI Rendering Toolkit](https://software.intel.com/en-us/rendering-framework) - The [Intel® Embree](http://embree.github.io) Ray Tracing Kernel Framework