Building LuxCoreRender - FAQ

Is it possible to set-up a local-only, end-to-end, build chain?

Yes it is, but for Linux only, at the moment, and starting with v2.11.

Also, important caveat: this kind of build is solely intended for development and tests. Do not use in production

• Step#1: Build dependencies locally

Use local plain build or local CI build of LuxCoreDeps

• Step#2: Inject local dependencies in LuxCore build

python -m build-system.luxmake.deps --local <path/to/deps> --release test

• Step#3: Build a testing wheel

make wheel-test

• Step#4: Inject testing wheel in Blender:

Use BlendLuxHelper

For a debugging with luxcoreui only, one can also replace steps #3 & #4 by:

• Step#3bis: Build luxcoreui:

make luxcoreui

Can I use git bisect?

Yes, if you need to find a faulty commit in LuxCore, you can use git bisect.

In that case, please note the correct verb to build LuxCoreRender at each step is

make clear && make deps && make

Caveat: this method only works for version >= v2.10.0

Example for Linux (please adapt to other contexts):

# Start git bisecting
git bisect start

# Define bounds
git bisect good samples-v2.10.0  # For instance
git bisect bad HEAD

# Build the app, test it and report status to git bisect
make clear && make deps && make  # Build at this stage
./out/install/Release/bin/luxcoreui mytestscene/render.cfg
git bisect <good|bad|skip>  # Depending on above test...

# Bisection loop
...

# At a certain point, the bisection stops and points at the faulty commit
# You can reset bisection
git bisect reset

Can I generate debug information for dependencies (LuxCoreDeps)?

Yes, it's possible, but only for local build, at the moment.

In this context, the build type is controlled by DEPS_BUILD_TYPE environment variable, so set it to your target build type before building:

export DEPS_BUILD_TYPE=Debug

After having built dependencies in local, you may want to inject them in LuxCore. This can be done with the following:

python -m build-system.luxmake.deps --local <path/to/deps> --release test --build-type=Debug

(this replaces make deps)

Can I build a sanitized version of LuxCore?

It is possible to build a sanitized version of LuxCore, including luxcoreui, luxcoreconsole, pyluxcore and the wheels. It just consists in setting the environment variable LUX_SANITIZE:

export LUX_SANITIZE=1  # or whatever value you want

2 caveats: - To come back to unsanitized build, you must unset LUX_SANITIZE. - Unfortunately, sanitized version of the wheel will not do with Blender, as Blender has special code to control sanitizing and will override our settings.