Repository files navigation

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

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

First, ensure you have a suitable toolchain:

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

Ensure the following software is also installed and available in the PATH:

• Git
• Github CLI (for dependency signature checking: optional, but recommended)
• Python 3
• Conan (pip install conan)
• CMake

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

git clone https://github.com/LuxCoreRender/LuxCore.gitcd LuxCoregit checkout for_v2.10make depsmake

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

Nota: secondmake statement can also name a specific target. Examples:make luxcoremake pyluxcoremake luxcoreconsolemake luxcoreui

Build type can be controlled by environment variableLUX_BUILD_TYPE.Available build types areRelease andDebug (case sensitive). Default isRelease.

• 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 is the new LuxCoreRender v2.x C++ and Python API. It is released under Apache PublicLicense v2.0 and can be freely used in open source and commercial applications.

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

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

To see how it works, just runluxcoreui 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)

This is a simple example of a command line renderer written using LuxCore API and it isavailable in thesamples/luxcoreconsole directory.Just runluxcoreconsole 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)

See AUTHORS.txt file.

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 andSHT Lab for HDR maps;
• Chronosphere for Cornell Blender scene;
• libPNG authors;
• zlib authors;
• OpenEXR authors;
• OpenImageIO authors;
• Tomas Davidovic forSmallVCM, 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 forperceptualdiff;
• Michael Labbe forNative File Dialog;
• Sven Forstmann'squadric mesh simplification code.
• SpdLog authors

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