Project Structure

Table of Contents

• Programs
• Plugins
• Libraries
• Tests
• Miscellaneous
• Deprecated Modules

This page contains an overview of the project's structure for you to quickly find the documentation or source code that you need. Photon is not a single library, it is composed of multiple libraries and programs. Together, they form a toolset for ultra realistic image synthesis.

Programs

• Editor: GUI for scene editing, rendering and debugging
  • Source Code
• PhotonCLI: Command-line interface of the renderer
  • Documentation
  • Source Code
• SDLGenCLI: Command-line interface for generating Photon Scene Description Language (PSDL) bindings
  • Source Code
• FilmMerger: Combine the output from multiple rendering sessions
  • Documentation
  • Source Code
• IntersectError: A small internal tool for estimating the accuracy of different ray-primitive intersection strategies
  • Source Code

Plugins

• PhotonBlend: Blender Add-on for Photon
  • Documentation
  • Source Code

Libraries

• Common: Common functionalities, definitions and utilities for Photon projects
  • Documentation
  • Source Code
• CEngine: C API of the render engine
  • Documentation
  • Source Code
• Engine: Rendering algorithms and core functionalities
  • Documentation
  • Source Code
• EditorLib: Core editor functionalities of the renderer
  • Documentation
  • Source Code
• SDLGen: Core of SDLGenCLI
  • Source Code

Tests

• EngineTest: Unit tests for the engine
  • Source Code
• EditorTest: Unit tests for the editor
  • Source Code
• RenderTest: End-to-end tests for the renderer
  • Example Report
  • Reports
  • Documentation
  • Source Code

Miscellaneous

• Example Scenes: Simple scenes for testing out the renderer
  • Scenes
• Scripts: Various scripts for setup and development
  • Source Code
• Resource: Additional resources for Photon
  • Repository
• ThirdParty: Customized third-party libraries for Photon
  • Repository

Deprecated Modules

• JNI: Java bindings for the engine
  • Source Code
• PhotonStudio: GUI for scene editing, rendering and debugging, with various utilities (e.g., Minecraft map parser, PSDL Java bindings, etc.)
  • Source Code