Dayflower

Dayflower is an application and a library for rendering in Java.

Its primary focus is photorealistic 3D-rendering, preferably in realtime. However, it can also be used for 2D-rendering and image processing.

Getting Started

To clone this repository and build the project using Apache Ant, you can type the following in Git Bash.

git clone https://github.com/macroing/Dayflower.git
cd Dayflower
ant

If you have cloned this repository and built the project using Apache Ant as presented above, you can run the project using its GUI in the following way.

cd distribution/Dayflower
java -Djava.library.path=lib/aparapi -jar Dayflower.jar

If you prefer to use Dayflower as a library and not as an application, the following Java source code demonstrates how you can use the CPU- and GPU renderers.

import org.dayflower.renderer.RenderingAlgorithm;
import org.dayflower.renderer.cpu.CPURenderer;
import org.dayflower.renderer.observer.FileRendererObserver;
import org.dayflower.scene.loader.JavaSceneLoader;

public class CPURendererExample {
    public static void main(String[] args) {
        CPURenderer cPURenderer = new CPURenderer(new FileRendererObserver("Image.png", true, false));
        cPURenderer.setScene(new JavaSceneLoader().load("./resources/scenes/CornellBox.java"));
        cPURenderer.setImage();
        cPURenderer.setMaximumBounce(20);
        cPURenderer.setMinimumBounceRussianRoulette(5);
        cPURenderer.setRenderingAlgorithm(RenderingAlgorithm.PATH_TRACING);
        cPURenderer.setup();
        cPURenderer.render(10);
        cPURenderer.dispose();
    }
}

import org.dayflower.renderer.RenderingAlgorithm;
import org.dayflower.renderer.gpu.GPURenderer;
import org.dayflower.renderer.observer.FileRendererObserver;
import org.dayflower.scene.loader.JavaSceneLoader;

public class GPURendererExample {
    public static void main(String[] args) {
        GPURenderer gPURenderer = new GPURenderer(new FileRendererObserver("Image.png", true, false));
        gPURenderer.setScene(new JavaSceneLoader().load("./resources/scenes/CornellBox.java"));
        gPURenderer.setImage();
        gPURenderer.setMaximumBounce(20);
        gPURenderer.setMinimumBounceRussianRoulette(5);
        gPURenderer.setRenderingAlgorithm(RenderingAlgorithm.PATH_TRACING);
        gPURenderer.setup();
        gPURenderer.render(10);
        gPURenderer.dispose();
    }
}

Supported Features

The tables below show the main features of the renderer.

Supported Rendering Algorithms

Supported Lights

Supported Materials

Supported Modifiers

Supported Shapes

Supported Textures

Documentation

The documentation for this library can be found in the Javadocs that are generated when building it.

Library

The following table describes the different APIs and their current status in the library.

Dependencies

• Java 8 - 17
• Aparapi
• Apache / Commons / BCEL
• Macroing / Java
• Macroing / Art4J

References

This library has been created with the help of many articles, books and renderer implementations.

The following list shows the renderer implementations that have been referenced the most, in alphabetical order.

• PBRT
• Rayito
• SmallPT
• Sunflow

Java 9 and Above

Dayflower is built for Java 8. When it's being used in Java 9 and above, certain problems are likely to occur. Some of them are presented below.

• JavaFX was removed from the JDK and the JRE when Java 11 was released. In Java 11 it has to be added manually.

Note

This library has not reached version 1.0.0 and been released to the public yet. Therefore, you can expect that backward incompatible changes are likely to occur between commits. When this library reaches version 1.0.0, it will be tagged and available on the "releases" page. At that point, backward incompatible changes should only occur when a new major release is made.