Build on Linux

This is a header-only library. No need to build anything. Just drop it in your source directory and off you go. The build step is solely for the examples, tests and the benchmark.

Note

For windows read this: Building on Windows with VCPKG.

Clone the repository

First, we need to clone the repository. If you are interested in running the tests or benchmarks, also run the second command which pulls doctest, nanoRT and madmann91/bvh.

git clone https://github.com/cstatz/blazert.git
git submodule update --init --recursive     # if you want to build the tests or benchmarks

Build

Before building, make sure that you have installed all the Dependencies.

We strictly recommend an out-of-source build in a separate directory (here for simplicity build) Starting in the source directory to project is build from the commandline as follows:

mkdir build
cd build
ccmake ../  # create cache and configuration
cmake --build .
cmake --build . -- install  # If package needs to be installed
ctest  # Runs the tests

Notes

Note

For maximum performance, we recommend building with gcc which results in a 15% to 20% better performance compared to clang (on linux and macOS). The provided benchmarks might be used to tune the compilation flags for your specific system and architecture.

Note

A word of caution: blazeRT will compile and work with compiler optimizations enabled (up to -O3), but needs infinite-math. If your application needs fast-math, ensure that the blazeRT code path is compiled with -fno-finite-math-only (in case of clang). In terms of performance, in its current form there is no major runtime difference between compilation with -O2 and -O3.