Lightmetrica – Research-oriented renderer

Warning

This project is under development for the initial release of Version 3. Please be careful using the versions in development because they might incur abrupt API changes.

Welcome to Lightmetrica Version 3 documentation! This documentation includes guide, examples and tests, and references.

Guide explains basic to advanced usage of the framework, for instance how to build the framework from the source or how to render the images, or how to extend the framework.

Example and tests illustrates actual usage of the framework using Python/C++ API and the results of functional/performance/statistics tests. The examples and tests are written in a Jupyter notebook and the results are always executed in a CI build. It guarantees that the results are always generated from the working version of the framework. In other words, the broken documentation indicates a new commit ruined the runtime behavior of the framework.

References describe the explanation of the detailed API and the components of the framework. API reference describes function-wise or interface-wise features of the framework. It is especially useful when you want develop your own extensions. Build-in component references describes the built-in components of the interfaces such as materials or renderers. It also explains a brief background of the theory behind the component. This reference is useful when you want to use the renderer as a user.

---

• Introduction
• Changelog

Guide

• Build
  • Prerequisites
  • Installing framework
  • Using pre-built binaries
  • Building from source
  • Editing documentation
  • Working with Jupyter notebook
  • Working with Docker containers
• Managing experiments
  • Common setup
  • Use-case: Framework users
  • Use-case: Plugin developers
  • Use-case: Framework developers
• Basic rendering
  • Lightmetrica API
  • Importing framework
  • Initialization
  • Loading asset
  • Accessing instance
  • Passing instance as a parameter
  • Scene setup using primitives
  • Scene setup using scene graph
  • Building acceleration structure
  • Rendering
  • Checking result
• Extending framework
  • Component interface
  • Configuring build environment
  • Implementing interface
  • Using extended feature from Python API
  • On advanced topics

Advanced Topics

• Build System
  • Modern CMake
  • Dependency management
  • Supporting add_submodule
  • Dependency management
• Component
  • Introduction
  • Creating interface
  • Implementing interface
  • Creating plugin
  • Creating instance
  • Parameterized creation
  • Component hierarchy and locator
  • Weak references
  • Querying information
  • Supporting serialization
  • Singleton
  • Changes from Version 2
• Python binding
  • Python API
• Path sampling
  • Notations
  • Scene interaction point
  • Point geometry
  • Component index
  • Ray-scene intersection query
  • Local ray/direction sampling
  • Transforming probability densities
  • Bidirectional path sampling
  • Summary of notations

Examples and tests

• Tests in Lightmetrica
  • Test types
  • Executing tests
• Examples
  • Rendering blank image
  • Rendering quad
  • Raycasting a scene with OBJ models
  • Rendering with path tracing
  • Rendering with custom renderer
  • Rendering with serialized assets
  • C++ examples
• Functional tests
  • Rendering all scenes
  • Checking consistency of acceleration structures
  • Error handling
  • Checking consistency of OBJ loader
  • Rendering with instanced geometries
  • Checking consistency of serialization
  • Updating already-loaded material
  • Scheduler for rendering
  • Materials
  • Lights
  • Renderers
• Performance tests
  • Performance testing of acceleration structures
  • Performance testing of OBJ loader
  • Performance testing of serialization

References

• Built-in component reference
  • Material
  • Camera
  • Light
  • Medium
  • Volume
  • Phase
  • Mesh
  • Texture
  • Model
  • Acceleration structure
  • Film
• API reference
  • User
  • Log
  • Exception
  • Parallel
  • Progress
  • Debug
  • Json
  • Math
  • OBJ loader
  • Component
  • Acceleration structure
  • Scene
  • Renderer
  • Camera
  • Film
  • Light
  • Participating medium
  • Volume data
  • Material
  • Phase function
  • Texture
  • Mesh
  • Model
  • Path sampling

Indices and tables

• Index

• Module Index

• Search Page