LuxCoreRender/LuxCore

LuxCoreRender

LuxCoreRender is a physically correct, unbiased rendering engine. It is built on physically based equations that model the transportation of light. This allows it to accurately capture a wide range of phenomena which most other rendering programs are simply unable to reproduce.

You can find more information about at https://www.luxcorerender.org

Building

Build documentation

Complete build documentation can be found in the wiki: https://wiki.luxcorerender.org/Building_LuxCoreRender.

Here is a short extract, please refer to link above for more information.

Tool requirements

[Mandatory] First, ensure you have a suitable toolchain:

• Windows: MSVC >= 194x latest version
• Linux: gcc 14
• MacOS Intel: XCode 15.2
• MacOS Arm: XCode 15.4

[Mandatory] Then, ensure the following software is also installed and available in the PATH:

• Git
• Python 3
• Conan (pip install conan)
• CMake

[Optional, but recommended] In addition, you may install the following software:

• Github CLI (for dependency signature checking)
• repairwheel (to build test wheels)
• nektos/act (to test Github scripts locally)
• Doxygen (to generate development documentation)

[Mandatory, Windows only] For Windows, ensure the command line is configured for building (vcvarsall.bat).

Quick build

git clone https://github.com/LuxCoreRender/LuxCore.git

cd LuxCore
git checkout for_v2.10

make deps
make

This will download LuxCore source code and LuxCore precompiled dependencies, configure CMake and start the build.

Nota: second make statement can also name a specific target. Examples: make luxcore make pyluxcore make luxcoreconsole make luxcoreui

Build type

Build type can be controlled by environment variable LUX_BUILD_TYPE. Available build types are Release and Debug (case sensitive). Default is Release.

Other commands

• make clean: clean build tree (delete intermediate files)
• make clear: remove build tree
• make config: configure/reconfigure project
• make deps: update dependencies
• make doc: build Doxygen documentation

LuxCore library

LuxCore is the new LuxCoreRender v2.x C++ and Python API. It is released under Apache Public License v2.0 and can be freely used in open source and commercial applications.

You can find more information about the API at https://wiki.luxcorerender.org/LuxCore_API

LuxCoreUI

This is the most complete example of LuxCore API usage and it is available in the samples/luxcoreui directory.

To see how it works, just run luxcoreui from the root directory:

Linux/MacOS:

./out/install/Release/bin/luxcoreui scenes/cornell/cornell.cfg

Windows:

out\install\Release\bin\luxcoreui scenes\cornell\cornell.cfg

(assuming you selected Release as a build type)

LuxCoreConsole

This is a simple example of a command line renderer written using LuxCore API and it is available in the samples/luxcoreconsole directory. Just run luxcoreconsole from the root directory with:

Linux/MacOS:

./out/install/Release/bin/luxcoreconsole -D batch.halttime 10 scenes/cornell/cornell.cfg

Windows:

out\install\Release\bin\luxcoreconsole -D batch.halttime 10 scenes\cornell\cornell.cfg

(assuming you selected Release as a build type)

Authors

See AUTHORS.txt file.

Credits

A special thanks goes to:

• Alain "Chiaroscuro" Ducharme for Blender 2.5 exporter and several scenes provided;
• Sladjan "lom" Ristic for several scenes provided;
• Riku "rikb" Walve for source patches;
• David "livuxman" Rodriguez for source patches;
• Daniel "ZanQdo" Salazar for Sala scene and Michael "neo2068" Klemm for SLG2 adaptation;
• Mourelas Konstantinos "Moure" for Room Scene;
• Diego Nehab for PLY reading/writing library;
• HDR Labs sIBL archive and SHT Lab for HDR maps;
• Chronosphere for Cornell Blender scene;
• libPNG authors;
• zlib authors;
• OpenEXR authors;
• OpenImageIO authors;
• Tomas Davidovic for SmallVCM, an endless source of hints;
• GLFW authors;
• ImGUI authors;
• Cycles authors for HSV/RGB conversion code;
• OpenVDB authors;
• Eigen authors;
• Yangli Hector Yee, Steven Myint and Jeff Terrace for perceptualdiff;
• Michael Labbe for Native File Dialog;
• Sven Forstmann's quadric mesh simplification code.
• SpdLog authors

License

This software is released under Apache License Version 2.0 (see COPYING.txt file).