Realtime Fractal Renderer Documentation
Home

System Requirements

Your device must contain a GPU that contains the OpenCL 1.2 runtime or newer. If your device contains multiple GPUs then the first one found by the program will be chosen.

Installation Guide

Pre-built binaries can be downloaded from the GitHub releases page https://github.com/SolomonBaarda/fractal-geometry-renderer/releases. Download and extract the .zip file for the version you would like to run.

User Guide

The application should be run from the command line. For example, using cmd on Windows, the Mandelbulb scene could be run using

FractalGeometryRenderer -s "kernels/mandelbulb.cl" -r 1920 1080

Command Line Options
Command Parameters Description
-h,–help Lists available commands
-s,–scene String/path Path to the scene to load
-i,–include List of strings/paths Additional file paths to be included by the OpenCL compiler
-r,–resolution Width and height as integers Resolution of the window to create
-w,–work-group-size Positive integer Manually specify the size of each work group (max is usually 256 for most devices)
-f,–force-high-precision Manually disable the fast-maths OpenCL compiler optimisations. This will result in a significant performance loss
-m,–mouse-sensitivity Float Mouse sensitivity when controlling the scene camera

By default, the kernels/include directory is included by the application. If your scene uses includes outside of this file, then the path must be specified when running the application using -i

Documentation for Manual Builds

Documentation for Scene Development Guide

Bug Report

Bugs should be reported using GitHub issues https://github.com/SolomonBaarda/fractal-geometry-renderer/issues