MobileRT: Mobile Ray Tracing engine
A portable Ray Tracing (RT) engine for multiple devices.
Already available interfaces for:
Android (through Java + JNI and C)
Linux, MacOS, Windows (through Qt 4 or 5)
Compatible with C++ compilers:
GNU C++ Compiler (g++)
Clang++
MinGW (g++)
Microsoft Visual C++ (MSVC)
Intel® oneAPI DPC++/C++ Compiler (ICX)
Run docker image
This C++ Ray Tracer is compatible with Android and Linux.
For Linux, if docker is installed, it is possible to try this ray tracer with ease by using the following commands to get the docker image and execute the container:
or (still WIP)
And a docker container should start and render the conference room model like the image above :)
Build docker image
For the most curious, this is the command used to build the docker image:
The docker image is in docker hub: https://hub.docker.com/r/ptpuscas/mobile_rt.
Compile Ray tracer
It is also possible to clone this repository and compile this ray tracer by yourself. To compile it, it is essential to install cmake and have a C++11 compiler. It is also needed the Qt4 or Qt5 library and the git control system to get the code from the repository.
Then, to finally compile this code, just create a build directory and compile in it, like for example:
Run Ray tracer
This ray tracer comes with a script with many functionalities useful to run static code analyzers and to benchmark the ray tracer itself. To execute the ray tracer just use the profile.sh
shell script available in the scripts
directory. The following command should start the ray tracer when executed in the root directory:
Android
To try this ray tracer for Android just download the APK file available in the repository.
Models Wavefront OBJ
To get some OBJ models, just download some from here: OBJs. Then, it will just be needed to add some lights in the scene geometry, by using some modeling application like 3D Blender. One thing to have it in account is to make sure the light material has the light emission component (Ke) with some positive values in the ".mtl" file. Finally, add a camera file with the extension ".cam" that should contain a definition of a perspective camera, like for example:
Third party frameworks / libraries used
Supported Operating Systems
OS | Versions | ||||||
---|---|---|---|---|---|---|---|
Android | |||||||
MacOS | |||||||
Windows | |||||||
Ubuntu | |||||||
CentOS | |||||||
Alpine | |||||||
Arch Linux | |||||||
Gentoo |
Requirements
It's necessary the following SDKs in order to compile this project for Android:
Android SDK which should also bring the Android NDK in order to compile the native code.
It's recommended to use the Android Studio
2023.2.1
which is compatible with Gradle 8.2.2 used by this project.
For native Linux, MacOS and Windows support, the install_dependencies.sh
script should download and install the necessary dependencies, by just calling:
Note that the script already supports multiple Linux distributions like:
Debian (using apt)
Red Hat (using yum)
Arch (using pacman)
Alpine (using apk)
Gentoo (using emerge)
It also supports installing dependencies in the following Operating Systems:
MacOS (using Homebrew)
Windows (using Chocolatey)
Note that these scripts are tested in Github actions pipeline only, so might assume that some tools were already installed. If the distribution you use is not supported, or it's missing the installation of some tool, you can always open an issue or even a pull request :)
Documentation
This project started as a Masters' dissertation. Click here to check the features list that are supported. Click here to check the code coverage and code duplication commands. Click here to build and serve the documentation locally. Click here for some basic Blender tips. Click here to check the Doxygen codebase documentation.
Last updated