LuxCoreRender Wiki - User contributions [en]

LuxCore SDL Reference Manual v2.11

2026-06-07T10:51:37Z

CodeHD: /* Camera */

The scene description language (SDL) is used to configure the renderer and to define objects, materials, textures etc. in the scene. 
The file ending of the render configuration file is ".cfg", for the scene file it's ".scn".

These files are usually created by exporter plugins, e.g. BlendLuxCore. 
This wiki page is primarily a reference for exporter developers, normal end-users should not need to edit cfg/scn files by hand.

Sometimes the API is updated faster than the wiki, in this case you can look at the code directly: https://github.com/LuxCoreRender/LuxCore/tree/master/src/slg/scene

Note that matrices are passed as flat lists in column-major form.

=Render configuration file=

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''resumerendering.filesafe''' || bool || 1 || enable/disable "safe save" mode for resume rendering file. A backup of the output is always valid even in the case of a system failure
|}

==Seed==

The global seed value that is used to generate random numbers. 
Two images rendered with the same seed will have the same noise pattern.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.seed''' || unsigned int || 1 || min 1
|}

==Periodic save==

Options related to periodic save operations.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''periodicsave.resumerendering.period''' || float || 0 || save the resume rendering file every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.resumerendering.filename''' || string || "resume.rsm" || the name to use to save the rendering resume information periodically
|-
|'''periodicsave.film.period''' || float || 0 || save the Film every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.film.filename''' || string || "film.flm" || the name to use to save the film periodically
|-
|'''periodicsave.film.outputs.period''' || float || 600 || save all Film outputs every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|}

==Render Engine==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.type''' || string || "PATHCPU" || engine type
|}

=== CPU Render Engines ===

CPU render engines are written in C++ and don't require OpenCL. All CPU render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''native.threads.count''' || int || CPU core count || > 0 || > 0 || The number of threads will be used for the rendering
|}

'''The following CPU engines are available:'''

===="PATHCPU"====

A path tracer with full image plane rendering (i.e. supporting Metropolis sampler).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|}

===="TILEPATHCPU"====
Biased path tracer with many control options and support for tile rendering. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|-
|'''tilepath.sampling.aa.size''' || int || 3 || > 0 || [1, 13] || All diffuse/glossy/specular samples are multiplied with the squared aa size: final_samples = aa^2 * (diffuse^2 + glossy^2 + specular^2)
|-
|'''tile.size''' || int || 32 || ≥ 8 || [8, 256] || Tile size in pixels
|-
|'''tile.multipass.enable''' || bool || 1 || 0 or 1 || o or 1 || Re-render the image until a halt threshold is met or indefinitely
|-
|'''tile.multipass.convergencetest.threshold''' || float || 6.0 / 256.0 || > 0.0 || [1.0 / 256.0, 6.0 / 256.0] || Target noise level
|-
|'''tile.multipass.convergencetest.threshold.reduction''' || float || 0.0 || [0.0, 1.0] || [0.75, 0.95] || Multiply noise level with this number when all tiles have met the previous noise level. Set to 0 to disable (so rendering will stop at the noise level)
|-
|'''tile.multipass.convergencetest.warmup.count''' || int || 32 || ≥ 0 || [8, 128] || Warm up period for the convergence test expressed in samples per pixel
|}

===="BIDIRCPU"====

A Bidirectional path tracer.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a eye path
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

===="RTPATHCPU"====
Engine optimized for interactive scene editing and camera movement. 
The sampler must be set to RTPATHCPUSAMPLER when using this engine.

Supports the same properties as [[#"PATHCPU" | "PATHCPU"]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpathcpu.zoomphase.size''' || int || 4 || || || render scaled down film for the first few frames after a scene edit (to make interactions more fluid)
|-
|'''rtpathcpu.zoomphase.weight''' || float || 0.1 || || || description: TODO
|}

=== OpenCL Render Engines ===

OpenCL engines can run on GPUs, CPUs and other types of computing devices, they require OpenCL to run. All OpenCL render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''opencl.platform.index''' || int || -1 || A valid platform index || -1 || Select the OpenCL platform to use. All devices available on all platforms will be used with -1
|-
|'''opencl.cpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL CPU devices available
|-
|'''opencl.gpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL GPU devices available
|-
|'''opencl.cpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.gpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.devices.select''' || string || "" || Any valid selection string || Any valid selection string || Select each OpenCL device to use. It is a string of "0" and "1". "1" means use the device, "0" do not
|}

'''The following OpenCL engines are available:'''

===="PATHOCL"====
OpenCL version of PATHCPU. Supports the same settings as [[#"PATHCPU" | PATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''pathocl.pixelatomics.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable pixel atomic operation
|-
|'''opencl.task.count''' || int || "AUTO" || "AUTO" or > 0 || [64K, 1024K] || The number of tasks sent to the OpenCL device in one kernel call
|}

===="RTPATHOCL"====

A PATHOCL version optimized for real-time rendering with fixed frame-rate and variable quality. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"PATHOCL" | PATHOCL]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpath.resolutionreduction.preview''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels in the first passes. For instance 4x4 than 2x2 and than always 1x1
|-
|'''rtpath.resolutionreduction.preview.step''' || int || 8 || > 0 || [1, 32] || Each preview step is rendered for n frames
|-
|'''rtpath.resolutionreduction''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels, outside the preview phase, in order to reduce the per frame rendering time
|}

===="TILEPATHOCL"====

OpenCL version of TILEPATHCPU. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"TILEPATHCPU" | TILEPATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''tilepathocl.devices.maxtiles''' || int || 16 || ≥ 1 || [1, 32] || Maximum number of tiles to send in a single call to each OpenCL device
|}

==="FILESAVER"===

Saves everything needed to render the scene to the output path, including textures and meshes.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''filesaver.format''' || string || "TXT" || "TXT" for a text SDL format and "BIN" for a single file binary format
|-
|'''filesaver.filename''' || string || "luxcore-exported-scene.bcf" || file name for "BIN" format
|-
|'''filesaver.directory''' || string || "luxcore-exported-scene" || output path for "TXT" format
|-
|'''filesaver.renderengine.type''' || string || "PATHCPU" || render engine to use when rendering the scene after it was saved with FILESAVER. Any engine string from above can be used here.
|}

===Experimental and debugging engines===

'''These engines are experimental, deprecated or are only intended for very specific purposes:'''

===="BIDIRVMCPU"====

Bidir with vertex merging, currently experimental. 
Supports the same settings as [[#"BIDIRCPU" | BIDIRCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''bidirvm.lightpath.count''' || int || 16 * 1024 || > 0 || || Number of lightpaths per pass
|-
|'''bidirvm.startradius.scale''' || float || 0.003 || > 0 || || Photon radius of the first pass
|-
|'''bidirvm.alpha''' || float || 3 || > 0 || [0.0, 1.0] || Photon radius is multiplied with this value after every pass to reduce the radius
|}

===="LIGHTCPU"====

For testing.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''light.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''light.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

==Sampler==

Samplers are used by following render engines:

* LIGHTCPU
* PATHCPU
* BIDIRCPU
* BIDIRVMCPU
* PATHOCL

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''sampler.type''' || string || "SOBOL" || sampler type
|}

The following samplers are available:

==="SOBOL"===

Sampler with sobol pattern.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.sobol.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==="METROPOLIS"===

Metropolis sampler.
Parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.metropolis.largesteprate''' || float || 0.4 || 0 ≤ x ≤ 1 || 0 - 1 || Probability of generating a large sample mutation
|-
|'''sampler.metropolis.maxconsecutivereject''' || int || 512 || x ≥ 0 || 0 - 32768 || Number of consecutive rejects before a next mutation is forced. Low values can cause bias
|-
|'''sampler.metropolis.imagemutationrate''' || float || 0.1 || 0 ≤ x ≤ 1 || 0 - 1 || Maximum distance over the image plane for a small mutation
|}

==="RANDOM"===

Fully random sampler. This sampler is mostly intended for testing purpose.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.random.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==Filter==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.type''' || string || "BLACKMANHARRIS" || || || Type of pixel filter.
|-
|'''film.filter.width''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Filter radius in pixels. Does not have an effect on the NONE filter
|-
|'''film.filter.xwidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|-
|'''film.filter.ywidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|}

Available filters are:

==="NONE"===

Disable pixel filtering.

==="BOX"===

Box pixel filter. No parameters.

==="GAUSSIAN"===

Gaussian pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.gaussian.alpha''' || float || 2.0 || x > 0.0 || 0.1 - 10.0 || Gaussian rate of falloff. Lower values give blurrier images.
|}

==="MITCHELL"===

Mitchel pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchell.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchell.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="MITCHELL_SS"===

Mitchel pixel filter with super-sampling (i.e. image will be filtered first with a grid of 4 pixels for each pixel).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchellss.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchellss.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="BLACKMANHARRIS"===

Blcakman-Harris pixel filter. No parameters.

==Light Strategy==

The direct light sampling strategy is defined by the following property:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.type''' || string || "LOG_POWER" || "UNIFORM", "POWER", "LOG_POWER" or "DLS_CACHE" || N/A || Direct light sampling strategy
|}

==="UNIFORM"===

"UNIFORM" light strategy samples evenly all light sources.

==="POWER"===

"POWER" light strategy samples the light sources based on their power.

==="LOG_POWER"===

"LOG_POWER" light strategy samples the light sources based on logarithm of their power.

==="DLS_CACHE"===

Build direct light sampling cache to optimize many-lights rendering, beneficial in scenes with multiple light sources with few overlap between their influence areas (e.g. a building with many disconnected rooms and interior lights).

Options for the DLS cache:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.entry.radius''' || float || 0.0 || || N/A || Entry radius in meters, automatic radius estimation is used if the radius is set to 0
|-
|'''lightstrategy.entry.normalangle''' || float || 25.0 || || N/A ||
|-
|'''lightstrategy.entry.maxpasses''' || int || 1024 || || N/A ||
|-
|'''lightstrategy.entry.convergencethreshold''' || float || 0.05 || || N/A ||
|-
|'''lightstrategy.entry.warmupsamples''' || int || 24 || || N/A ||
|-
|'''lightstrategy.targetcachehitratio''' || float || 0.995 || || N/A ||
|-
|'''lightstrategy.maxdepth''' || int || 4 || || N/A ||
|-
|'''lightstrategy.maxsamplescount''' || int || 10000000 || || N/A ||
|-
|'''lightstrategy.persistent.file''' || string || "" || || N/A ||
|-
|'''lightstrategy.persistent.safesave''' || bool || 1 || || N/A ||

|}

==Accelerator==

The ray/triangle intersection accelerator to use for the rendering is defined by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''accelerator.type''' || string || "AUTO" || "AUTO", "BVH", "MBVH", "EMBREE" || "AUTO" || The intersection accelerator. "AUTO" will select the best one available for the current [[LuxRays]] intersection device. "EMBREE" is currently usable only on CPU render engines
|-
|'''accelerator.instances.enable''' || bool || 1 || 0 or 1 || 0 or 1 || Enable instance support (or disable in order to slightly increase rendering speed)
|}

==Epsilon==

Minimum and maximum allowed value for scene epsilon can be define by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''scene.epsilon.min''' || float || 1e-5f || Any float value || 1e-6f ≤ x ≤ 1e-1f || Minimum allowed value for scene epsilon
|-
|'''scene.epsilon.max''' || float || 1e-1f || Any float value || 1e-3f ≤ x ≤ 1e+2f || Maximum allowed value for scene epsilon
|}

==Film==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.safesave''' || bool || 1 || enable "safe save" of Film serialization. A backup of the output is always valid even in the case of a system failure.
|}

===Film OpenCL Options===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.opencl.enable''' || bool || 1 || enable OpenCL film operations
|-
|'''film.opencl.platform''' || unsigned int || -1 || choose which platform will be used by the film operations. (0 is first platform, 1 second and so on. -1 for all)
|-
|'''film.opencl.device''' || unsigned int || -1 || choose which device will be used by the film operations. (0 is first device, 1 second and so on. -1 for first GPU device)
|}

===Film Outputs (aka AOVs)===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.safesave''' || bool || 1 || enable "safe save" for Film outputs. A backup of the output is always valid even in the case of a system failure
|}

The film object supports many types of outputs (aka AOVs). The complete list of supported output types:

{| class="wikitable" cellspacing="2"
!Name
!Type
|-
|'''RGB''' || HDR
|-
|'''RGBA''' || HDR
|-
|'''RGB_IMAGEPIPELINE''' || HDR/LDR
|-
|'''RGBA_IMAGEPIPELINE''' || HDR/LDR
|-
|'''ALPHA''' || HDR/LDR
|-
|'''DEPTH''' || HDR
|-
|'''POSITION''' || HDR
|-
|'''GEOMETRY_NORMAL''' || HDR
|-
|'''SHADING_NORMAL''' || HDR
|-
|'''MATERIAL_ID''' || LDR
|-
|'''DIRECT_DIFFUSE''' || HDR
|-
|'''DIRECT_GLOSSY''' || HDR
|-
|'''EMISSION''' || HDR
|-
|'''INDIRECT_DIFFUSE''' || HDR
|-
|'''INDIRECT_GLOSSY''' || HDR
|-
|'''INDIRECT_SPECULAR''' || HDR
|-
|'''MATERIAL_ID_MASK''' || HDR/LDR
|-
|'''DIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''INDIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''RADIANCE_GROUP''' || HDR/LDR
|-
|'''UV''' || HDR/LDR
|-
|'''RAYCOUNT''' || HDR/LDR
|-
|'''BY_MATERIAL_ID''' || HDR/LDR
|-
|'''IRRADIANCE''' || HDR
|-
|'''OBJECT_ID''' || LDR
|-
|'''OBJECT_ID_MASK''' || HDR/LDR
|-
|'''BY_OBJECT_ID''' || HDR/LDR
|-
|'''SAMPLECOUNT''' || HDR/LDR
|-
|'''CONVERGENCE''' || HDR/LDR
|-
|'''NOISE''' || HDR/LDR
|-
|'''SERIALIZED_FILM''' || N/A
|-
|'''MATERIAL_ID_COLOR''' || HDR/LDR
|}

Outputs are enabled with the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.<index>.type''' || string || || Type of output, e.g. "RGBA" or "ALPHA" (see the list above for the available types)
|-
|'''film.outputs.<index>.filename''' || string || || Filename to use when saving the output. The filename should use ".exr" as extension for HDR outputs and ".png" for LDR outputs (see list above for which output is HDR and which LDR)
|-
|'''film.outputs.<index>.id''' || int || || Specify for the following outputs: '''MATERIAL_ID_MASK''', '''RADIANCE_GROUP''', '''BY_MATERIAL_ID''', '''OBJECT_ID_MASK''', '''BY_OBJECT_ID''' (to choose the object ID, material ID or radiance group ID of the output)
|-
|'''film.outputs.<index>.index''' || int || || Specify for an imagepipeline output (RGB_IMAGEPIPELINE or RGBA_IMAGEPIPELINE) to select the imagepipeline of the output. For example, if you have 3 imagepipelines defined, and you want to specify the output of the third imagepipeline, use 2 for the ".index" property of the output
|}

Note that the Bidir engine does not support all AOVs.
Not supported by Bidir are: EMISSION, DIRECT_DIFFUSE, DIRECT_GLOSSY, INDIRECT_DIFFUSE, INDIRECT_GLOSSY, INDIRECT_SPECULAR, DIRECT_SHADOW_MASK, INDIRECT_SHADOW_MASK, IRRADIANCE, RAYCOUNT.

This is the list of output channel data types and sizes:

{| class="wikitable" cellspacing="2"
!Output type
!Data type
!Size
!Description
|-
|RGB||float||film width x film height x 3||R, G, B
|-
|RGB_IMAGEPIPELINE||float||film width x film height x 3||R, G, B
|-
|RGBA||float||film width x film height x 4||R, G, B, A
|-
|ALPHA||float||film width x film height x 1||Alpha value [0, 1]
|-
|DEPTH||float||film width x film height x 1||Camera distance
|-
|POSITION||float||film width x film height x 3||World X, Y, Z
|-
|GEOMETRY_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|SHADING_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|DIRECT_DIFFUSE||float||film width x film height x 3||Diffuse R, G, B
|-
|DIRECT_GLOSSY||float||film width x film height x 3||Glossy R, G, B
|-
|EMISSION||float||film width x film height x 3||Emission R, G, B
|-
|INDIRECT_DIFFUSE||float||film width x film height x 3||Indirect diffuse R, G, B
|-
|INDIRECT_GLOSSY||float||film width x film height x 3||Indirect glossy R, G, B
|-
|INDIRECT_SPECULAR||float||film width x film height x 3||Indirect specular R, G, B
|-
|MATERIAL_ID_MASK||float||film width x film height x 1||Material mask [0, 1]
|-
|DIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|INDIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|RADIANCE_GROUP||float||film width x film height x 3||R, G, B
|-
|UV||float||film width x film height x 2||Texture coordinates U, V
|-
|RAYCOUNT||float||film width x film height x 1||Ray count
|-
|BY_MATERIAL_ID||float||film width x film height x 3||By material ID
|-
|MATERIAL_ID||uint||film width x film height x 1||Material ID
|-
|IRRADIANCE||float||film width x film height x 3||R, G, B
|-
|OBJECT_ID_MASK||float||film width x film height x 1||Object mask [0, 1]
|-
|BY_OBJECT_ID||float||film width x film height x 3||By object ID
|-
|OBJECT_ID||uint||film width x film height x 1||Object ID
|-
|SAMPLECOUNT||uint||film width x film height x 1||Sample count
|-
|CONVERGENCE||float||film width x film height x 1||The distance of each pixel from the convergence threshold
|-
|NOISE||float||film width x film height x 1||The noise estimated for each pixel
|-
|SERIALIZED_FILM||N/A||N/A||The complete Film serialized in binary format
|-
|MATERIAL_ID_COLOR||float||film width x film height x 3||Material ID converted to colors (with anti-aliasing)
|}

===Film Channels===

Film channels are implicitly enabled by declaring film outputs (even if the output is never used). For instance, declaring a "RGBA" output will automatically enable "RADIANCE_PER_PIXEL_NORMALIZED" (and "RADIANCE_PER_SCREEN_NORMALIZED" for BIDIRCPU) and "ALPHA".
The supported channels are:

{| class="wikitable" cellspacing="2"
!Channel type
!Data type
!Size
!Last element is weight ?
!Note
|-
|CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED||float||film width x film height x 4||Yes||One for each radiance group. Eye paths radiance.
|-
|CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED||float||film width x film height x 3||No||One for each radiance group. Light paths radiance. Used only by LIGHTCPU and BIDIRCPU.
|-
|CHANNEL_ALPHA||float||film width x film height x 2||Yes||
|-
|CHANNEL_RGB_IMAGEPIPELINE||float||film width x film height x 3||No||
|-
|CHANNEL_DEPTH||float||film width x film height x 1||No||
|-
|CHANNEL_POSITION||float||film width x film height x 3||No||
|-
|CHANNEL_GEOMETRY_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_SHADING_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_MATERIAL_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_DIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_DIRECT_GLOSSY||float||film width x film height x 4||Yes||
|-
|CHANNEL_EMISSION||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_SPECULAR||float||film width x film height x 4||Yes||
|-
|CHANNEL_MATERIAL_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_DIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_INDIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_UV||float||film width x film height x 2||No||
|-
|CHANNEL_RAYCOUNT||float||film width x film height||No||
|-
|CHANNEL_BY_MATERIAL_ID||float||film width x film height x 4||Yes||
|-
|CHANNEL_IRRADIANCE||float||film width x film height x 4||Yes||
|-
|CHANNEL_OBJECT_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_OBJECT_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_BY_OBJECT_ID||float||film width x film height x 4||Yes||
|}

This is the list of channels enabled by each output:

{| class="wikitable" cellspacing="2"
!Output
!Enabled channels
|-
|'''RGB''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''RGB_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''ALPHA''' || ALPHA
|-
|'''DEPTH''' || DEPTH
|-
|'''POSITION''' || DEPTH, POSITION
|-
|'''GEOMETRY_NORMAL''' || DEPTH, GEOMETRY_NORMAL
|-
|'''SHADING_NORMAL''' || DEPTH, SHADING_NORMAL
|-
|'''MATERIAL_ID''' || DEPTH, MATERIAL_ID
|-
|'''DIRECT_DIFFUSE''' || DIRECT_DIFFUSE
|-
|'''DIRECT_GLOSSY''' || DIRECT_GLOSSY
|-
|'''EMISSION''' || EMISSION
|-
|'''INDIRECT_DIFFUSE''' || INDIRECT_DIFFUSE
|-
|'''INDIRECT_GLOSSY''' || INDIRECT_GLOSSY
|-
|'''INDIRECT_SPECULAR''' || INDIRECT_SPECULAR
|-
|'''MATERIAL_ID_MASK''' || MATERIAL_ID, MATERIAL_ID_MASK
|-
|'''DIRECT_SHADOW_MASK''' || DIRECT_SHADOW_MASK
|-
|'''INDIRECT_SHADOW_MASK''' || INDIRECT_SHADOW_MASK
|-
|'''RADIANCE_GROUP''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''UV''' || DEPTH, UV
|-
|'''RAYCOUNT''' || DEPTH, RAYCOUNT
|-
|'''BY_MATERIAL_ID''' || BY_MATERIAL_ID
|-
|'''IRRADIANCE''' || IRRADIANCE
|-
|'''OBJECT_ID''' || DEPTH, OBJECT_ID
|-
|'''OBJECT_ID_MASK''' || OBJECT_ID, OBJECT_ID_MASK
|-
|'''BY_OBJECT_ID''' || BY_OBJECT_ID
|}

Note: CHANNEL_RGB_IMAGEPIPELINE is always enable and the result of running the image pipeline.

===Image pipeline===

It is possible to define multiple image pipelines at the same time by using the '''film.imagepipelines.<pipeline #>.''' properties prefix. Each image pipeline takes as input the raw rendering and is a chain off image pipeline plugins. Each plugin receives previous plugin output and produces a new output.

====Radiance Group====

Radiance groups are used to get only the contribution of a group of lights in the scene. 
Lights can be grouped by setting their [[#Common_parameters | '''.id''']] property to the same number, on materials this is done with the [[#Light_emission | '''.emission.id''']] property. 

Note that the OpenCL engines only support up to 8 radiance groups (one of them is the default group).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.globalscale''' || float|| 1 || global weighting of radiance group
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.temperature ''' || float || 6500.0 || light temperature
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.rgbscale''' || vector || 1.0 1.0 1.0 || light color
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.radiancescales.<id>.enabled''' || bool || 1 || enable radiance group
|}

====Image pipeline plug-ins====

=====Type: TONEMAP_LINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || linear tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 1.0 || tonemapping scale
|}

=====Type: TONEMAP_REINHARD02=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_REINHARD02" || reinhard tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.prescale''' || float || 1.0 || reinhard prescale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.postscale''' || float || 1.2 || reinhard postscale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.burn''' || float || 3.75 || reinhard burn
|}

=====Type: TONEMAP_AUTOLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_AUTOLINEAR" || automatic linear tonemapping
|}

=====Type: TONEMAP_LUXLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LUXLINEAR" || linear tonemapping with real camera settings
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sensitivity''' || float || 100.0 || ISO sensitivity
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.exposure''' || float || 0.001 || exposure time
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.fstop''' || float || 2.8 || f/aperture
|}

=====Type: NOP=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipeline.<pipeline #>.<plugin #>.type''' || string || "NOP" || no parameters tonemapper
|}

=====Type: GAMMA_CORRECTION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || gamma correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.value''' || float || 2.2 || gamma value
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.table.size''' || unsigned int || 4096 || resolution
|}

=====Type: OUTPUT_SWITCHER=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OUTPUT_SWITCHER" || overwrite output
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.channel''' || string || "DEPTH" || channel whose values are used to overwrite
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.index''' || unsigned int || 0 || index
|}

=====Type: GAUSSIANFILTER_3x3=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "GAUSSIANFILTER_3x3" || gaussian filter
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.15 || blurring weight
|}

=====Type: CAMERA_RESPONSE_FUNC=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || CAMERA_RESPONSE_FUNC || analog camera film simulation
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.name''' || string || "Advantix_100CD" || film type
|}

=====Type: BACKGROUND_IMG=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || BACKGROUND_IMG || show the background image where alpha < 1 (simple compositing)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || ... || background image path (e.g scenes/simple-mat/sky.exr)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.gamma''' || float || 2.2 || background image gamma
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.storage ''' || string || auto || background image storage type
|}
Note: When the size of the background image differs from the film size, it will be stretched to fit the film size.

=====Type: BLOOM=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "BLOOM" || bloom effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.radius''' || float || 0.07 || how large the bloom effect is in % of the image size (i.e. 1.0 = all image)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.25 || how strong the effect is (i.e. 0.0 = nothing, 1.0 = max. strength)
|}

=====Type: VIGNETTING=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "VIGNETTING" || vignetting effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 0.4 || vignetting strength
|}

=====Type: COLOR_ABERRATION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_ABERRATION" || color aberration effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || color aberration amount
|}

=====Type: MIST=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "MIST" || aerial perspective effect (fake fog)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.color''' || spectrum|| [1, 1, 1] || mist color
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || mist amount
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.startdistance''' || float || 0 || distance from camera until where the mist effect has zero effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.enddistance''' || float || 10000 || distance from camera from where the mist effect has maximum effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.excludebackground''' || bool || false || Do not apply mist effect on pixels with infinite distance to the camera
|}

=====Type: CONTOUR_LINES=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "CONTOUR_LINES" || contour lines for IRRADIANCE AOV
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.range''' || float|| ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.steps''' || int || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.zerogridsize''' || int || ? || ?
|}

=====Type: WHITE_BALANCE =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "WHITE_BALANCE" || White temperature correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.temperature''' || unsigned int|| 6500 || Target image temperature in Kelvin
|-
|}

=====Type: COLOR_LUT =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_LUT" || Applies .cube LUT (look-up-table) to the input
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || "lut.cube" || Filepath to a [https://wwwimages2.adobe.com/content/dam/acom/en/products/speedgrade/cc/pdfs/cube-lut-specification-1.0.pdf .cube LUT file]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.strength''' || float || 1.0 || Linear interpolation between input (0.0) and output (1.0) of the plugin
|-
|}

=====Type: INTEL_OIDN =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "INTEL_OIDN" || Denoises the image using [https://github.com/OpenImageDenoise/oidn Intel OIDN]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.filter.type''' || string || "RT" ||
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.oidnmemory''' || int || 6000 || Approximate maximum amount of memory to use in megabytes (actual memory usage may be higher). Limiting memory usage may cause slower denoising due to internally splitting the image into overlapping tiles
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

=====Type: OPTIX_DENOISER =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OPTIX_DENOISER" || Denoises the image using the Nvidia OptiX denoiser
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.minspp''' || unsigned int || 0 || Minimum amount of samples to be rendered before the plugin is run (at lower sample numbers, it does not modify the input)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

===Film Subregion===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.subregion''' || vector || ... || <xstart> <xstop> <ystart> <ystop>
|}

===Rendering halt conditions===

By default, a LuxCore rendering will never stop however you can enable one or multiple halt conditions:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''batch.haltnoisethreshold''' || float || -1.0 || enable image convergence test and stops when the error is under the defined value. Use a value like "n / 256.0" where n is the level of error you are looking for. It may be hard to achieve a level of error smaller than 3.0 / 256.0. -1.0 disables the halt condition.
|-
|'''batch.haltnoisethreshold.warmup''' || unsigned int || 64 || number of average samples per pixel before to start the convergence test
|-
|'''batch.haltnoisethreshold.step''' || unsigned int || 64 || number of average samples per pixel between two tests
|-
|'''batch.haltnoisethreshold.filter.enable''' || bool || 1 || if the CONVERGENCE AOV (generated by the batch.haltnoisethreshold) should be filtered or not with a 3x3 box filter
|-
|'''batch.haltnoisethreshold.stoprendering.enable''' || bool || 1 || Set this to 0 (false) if you only want to use the haltnoisethreshold settings for adaptive sampling in an endless render
|-
|'''batch.haltnoisethreshold.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for stopping
|-
|'''batch.halttime''' || float || 0.0 || number of seconds before stopping the rendering
|-
|'''batch.haltspp''' || unsigned int || 0 || number of average samples per pixel before stopping the rendering
|}

===Noise estimation===

Image noise can be estimated and its result can be used to drive the Sobol and Random samplers to focus its sampling in the noisier regions.
Setting any of these properties will enable the noise estimation.
The adaptiveness strength is a Sampler property.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.noiseestimation.warmup''' || unsigned int || 32 || number of average samples per pixel before to start the convergence test
|-
|'''film.noiseestimation.step''' || unsigned int || 32 || number of average samples per pixel between two tests
|-
|'''film.noiseestimation.filter.scale''' || unsigned int || 4 || Box filter scale used to filter the NOISE AOV (generated by the noise estimation). Set to 0 to disable.
|-
|'''film.noiseestimation.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for adaptive sampling
|-
|}

=Scene file=

==Camera==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.type''' || string || "perspective" || "perspective", "orthographic", "environment" (360° panorama mapped in latlong format) or "stereo"
|-
|'''scene.camera.lookat.orig''' || point (float float float) || 0.0 10.0 0.0 || camera location
|-
|'''scene.camera.lookat.target''' || point (float float float) || 0.0 0.0 0.0 || camera target
|-
|'''scene.camera.up''' || vector (float float float) || (0.0, 0.0, 1.0) || camera up vector
|-
|'''scene.camera.fieldofview''' || float || 45.0 || field of view
|-
|'''scene.camera.shutteropen''' || float || 0.0 || camera shutter open time (used for motion blur)
|-
|'''scene.camera.shutterclose''' || float || 0.0 || camera shutter close time (used for motion blur)
|-
|'''scene.camera.autovolume.enable''' || bool || true || try automatically to discover scene.camera.volume
|-
|'''scene.camera.volume''' || string || || the initial volume rays will travel in
|-
|'''scene.camera.cliphither''' || float || 1e-3 || Near clipping distance
|-
|'''scene.camera.clipyon''' || float || 1e30 || Far clipping distance
|-
|'''scene.camera.screenwindow''' || list (float float float float) || 0.0 1.0 0.0 1.0 || <xstart> <xstop> <ystart> <ystop> (Only for "perspective"/"orthographic"/"environment")
|-
|'''scene.camera.bokeh.distribution.type''' || string || NONE || "NONE", "UNIFORM", "EXPONENTIAL", "INVERSEEXPONENTIAL", "GAUSSIAN", "INVERSEGAUSSIAN", "TRIANGULAR", "CUSTOM" (Only for "perspective")
|-
|'''scene.camera.bokeh.blades''' || int || 0 || Number of aperture blades (Only for "perspective")
|-
|'''scene.camera.bokeh.power''' || int || 3 || Distribution factor, only for "EXPONENTIAL" and "INVERSEEXPONENTIAL" types (Only for "perspective")
|-
|'''scene.camera.bokeh.distribution.image''' || string || "image.png" || only if type == "CUSTOM" (Only for "perspective")
|-
|'''scene.camera.bokeh.scalex''' || float || 1.0 || Horizontal scale of the Bokeh (Only for "perspective")
|-
|'''scene.camera.bokeh.scaley''' || float || 1.0 || Vertical scale of the Bokeh (Only for "perspective")
|-
|'''scene.camera.stereo.type''' || string || "perspective" || "perspective", "environment_180", "environment_360"
|-
|'''scene.camera.eyesdistance''' || float || 0.0626 || Distance between the individual cameras (Only for "stereo")
|-
|'''scene.camera.lensdistance''' || float || 0.2779 || TBD (Only for "stereo")
|-
|'''scene.camera.oculusrift.barrelpostpro.enable''' || bool || false || TBD (Only for "perspective"/"stereo")
|-
|'''scene.camera.environment.degrees''' || float || 360.0 || TBD (Only for "environment")
|-
|'''scene.camera.lensradius''' || float || 0.0 || Radius of the lens aperture, used for bokeh calculation (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.focaldistance''' || float || 10.0 || Distance to the lens focus point, used for bokeh calculation (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.autofocus.enable''' || bool || false || Apply autofocus, automatically determines "focaldistance" (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.enable''' || bool || false || Activates clipping plane (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.center''' || point (float float float) || 0.0 0.0 0.0 || Specifies one point in the clipping plane (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.normal''' || vector (float float float) || 0.0 0.0 0.0 || Specififes the normal vector of the clipping plane (Only for "perspective"/"orthographic"/"stereo")
|-
|}

The camera supports motion blur. See [[ LuxCore_SDL_Reference_Manual_v2.0#Object_Motion_Blur | Object Motion Blur ]]. 
(Only difference being that instead of the prefix '''scene.objects.<object name>''', the prefix '''scene.camera''' is used when setting motion properties of the camera)

==Textures==

Check [[LuxCoreRender_Textures|LuxCoreRender Textures]] for a high level description and examples of the textures.

===Mapping===

Some texture (mostly procedural textures) supports 2D or 3D mapping parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping2d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.rotation''' || float || 0.0 || UV rotation (in degrees)
|-
|'''scene.textures.<texture name>.mapping.uvscale''' || UV || 1.0 1.0 || UV scale
|-
|'''scene.textures.<texture name>.mapping.uvdelta''' || UV || 0.0 0.0 || UV translation
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "globalmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

===Type: add===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "add" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: subtract===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "subtract" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: band===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "band" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5|| texture name or constant
|-
|'''scene.textures.<texture name>.interpolation''' || string || "linear"|| "linear", "cubic" or "none"
|-
|'''scene.textures.<texture name>.offset[0..n]''' || float || 0.0 || multiple offsets in the range of [0.0, 1.0]
|-
|'''scene.textures.<texture name>.value[0..n]''' || spectrum || 1.0 1.0 1.0 || a value for each offset
|}

===Type: blender_blend===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_blend" || type of texture
|-
|'''scene.textures.<texture name>.progressiontype''' || string || "linear" || linear, quadratic, easing, diagonal, spherical, quadratic_spherical, halo or radial
|-
|'''scene.textures.<texture name>.direction''' || string || "horizontal" || horizontal or vertical
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_clouds===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_clouds" || type of texture
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || hard_noise or soft_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_distortednoise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_distortednoise" || type of texture
|-
|'''scene.textures.<texture name>.noise_distortion''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.distortion''' || float || 1 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_magic===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_magic" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_marble===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_marble" || type of texture
|-
|'''scene.textures.<texture name>.marbletype''' || string || "soft" || soft, sharp or sharper
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_musgrave===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_musgrave" || type of texture
|-
|'''scene.textures.<texture name>.musgravetype''' || string || "multifractal" || multifractal, ridged_multifractal, hybrid_multifractal, fBM or hetero_terrain
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.dimension''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.lacunarity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.offset''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.octaves''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_noise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_noise" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_stucci===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_stucci" || type of texture
|-
|'''scene.textures.<texture name>.stuccitype''' || string || "plastic" || plastic, wall_in or wall_out
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_wood===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || bands, rings, bandnoise or ringnoise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_voronoi===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_voronoi" || type of texture
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.distmetric''' || string || "actual_distance" || actual_distance, distance_squared, manhattan, chebychev, minkowski_half, minkowski_four or minkowski
|-
|'''scene.textures.<texture name>.w1''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.w2''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w3''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w4''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: brick===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "brick" || type of texture
|-
|'''scene.textures.<texture name>.bricktex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.mortartex''' || texture || 0.2 0.2 0.2 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodtex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodbias''' || float || 0.0 || With bias = -1, only the bricktex is used for the brick color. With bias between -1 and 1, a pseudo-random interpolation between bricktex and brickmodtex is used as brick color. With bias = 1, only the brickmodtex is used for the brick color.
|-
|'''scene.textures.<texture name>.brickbond''' || string || "running" || "flemish", "english", "herringbone", "basket" or "chain link"
|-
|'''scene.textures.<texture name>.brickwidth''' || float || 0.3 || brick width
|-
|'''scene.textures.<texture name>.brickheight''' || float || 0.1 || brick height
|-
|'''scene.textures.<texture name>.brickdepth''' || float || 0.15 || brick depth
|-
|'''scene.textures.<texture name>.mortarsize''' || float || 0.01 ||mortar size
|-
|'''scene.textures.<texture name>.brickrun''' || float || 0.75 || brick run
|}

This texture supports 3D mapping.

===Type: checkerboard3d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard3d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 3D mapping.

===Type: checkerboard2d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard2d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: constfloat1===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat1" || type of texture
|-
|'''scene.textures.<texture name>.value''' || float || 1.0 || constant value
|}

===Type: constfloat3===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat3" || type of texture
|-
|'''scene.textures.<texture name>.value''' || spectrum || (1.0, 1.0, 1.0) || RGB constant value
|}

===Type: densitygrid===

You can use ".data", ".data3" or ".openvdb.file" to define the 3D grid values.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "densitygrid" || type of texture
|-
|'''scene.textures.<texture name>.nx''' || unsigned int || || grid x size
|-
|'''scene.textures.<texture name>.ny''' || unsigned int || || grid y size
|-
|'''scene.textures.<texture name>.nz''' || unsigned int || || grid z size
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.storage''' || string || "half" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.data''' || float || || vector grid values (total count: nx * ny * nz)
|-
|'''scene.textures.<texture name>.data3''' || float || || vector grid values (total count: nx * ny * nz * 3)
|-
|'''scene.textures.<texture name>.openvdb.file''' || string || || OpenVDB file name
|-
|'''scene.textures.<texture name>.openvdb.grid''' || string || || OpenVDB grid name to read from the file
|}

===Type: dots===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dots" || type of texture
|-
|'''scene.textures.<texture name>.inside''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.outside''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: fbm===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fbm" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: fresnelapproxk===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxk" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: fresnelapproxn===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxn" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: hitpointalpha===

Use the value obtained by interpolating triangle vertices alphas.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointalpha" || type of texture
|}

===Type: hitpointcolor===

Use the color obtained by interpolating triangle vertices colors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointcolor" || type of texture
|}

===Type: hitpointgrey===

Use the value obtained by interpolating triangle vertices colors, mapped to a float value (RGB converted into greyscale).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointgrey" || type of texture
|-
|'''scene.textures.<texture name>.channel''' || int || -1 || the index of the RGB channel to use. -1 means the luminance of the RGB value
|}

===Type: hsv===

Hue saturation value manipulation.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hsv" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input color that will be manipulated
|-
|'''scene.textures.<texture name>.hue''' || texture || 0.5 || shift in hue (range: 0..1)
|-
|'''scene.textures.<texture name>.saturation''' || texture || 1.0 || saturation (range: 0..inf)
|-
|'''scene.textures.<texture name>.value''' || texture || 1.0 || brightness multiplier (range: 0..inf)
|}

===Type: imagemap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "imagemap" || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || "image.png" || name of the image file
|-
|'''scene.textures.<texture name>.gamma''' || float || 2.2 || gamma correction value used in the image
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 || image values are multiplied by gain value
|-
|'''scene.textures.<texture name>.storage''' || string || "auto" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of image map wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.channel''' || string || "default" || extract from the image only the selected channels: "default", "red", "green", "blue", "alpha", "mean", "colored_mean", "rgb"
|}

===Type: normalmap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "normalmap" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input. Is treated as an XYZ vector in tangent space.
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || multiplier for adjusting normalmap height
|}

===Type: marble===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "marble" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || marble scale
|-
|'''scene.textures.<texture name>.variation''' || float || 0.2 || marble variation
|}

This texture supports 3D mapping.

===Type: mix===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "mix" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.texture1''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: scale===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "scale" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: uv===

This procedural texture has no parameters aside from the support of 2D mapping.

===Type: windy===

This procedural texture has no parameters aside from the support of 3D mapping.

===Type: wood===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || "bands", "rings", "bandnoise" or "ringnoise"
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || "sin", "saw" or "tri"
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || "soft_noise" or "hard_noise"
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 || noise size
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 || noise turbulence
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 || bright
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 || contrast
|}

This texture supports 3D mapping.

===Type: wrinkled===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wrinkled" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: abs===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "abs" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|}

===Type: clamp===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "clamp" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.min''' || float || 0.0 || lower boundary of the clamping
|-
|'''scene.textures.<texture name>.max''' || float || 1.0 || upper boundary of the clamping
|}

===Type: divide===

Note: If texture2 (the divisor) is 0, 0 is returned.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "divide" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant (dividend)
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant (divisor)
|}

===Type: remap===

This texture brings the value from the source range into the target range.

Note: The value is clamped into source range before performing the remap operation, and the resulting number is also clamped into the target range.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "remap" || type of texture
|-
|'''scene.textures.<texture name>.value''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemax''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmax''' || texture || 1.0 || texture name or constant
|}

===Type: objectid===

Raw object ID (range 0 to 0xfffffffe).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectid" || type of texture
|}

===Type: objectidcolor===

Object ID interpreted as color. 
The object ID is a 4 byte unsigned int. To convert to color, the lower three bytes are interpreted as r, g, b values (each range 0 to 255). The highest byte is ignored.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidcolor" || type of texture
|}

===Type: objectidnormalized===

Normalized object ID (range 0 to 1).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidnormalized" || type of texture
|}

===Type: dotproduct ===

Dot product of the two input vectors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dotproduct" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: power ===

pow(base, exponent)

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "power" || type of texture
|-
|'''scene.textures.<texture name>.base''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.exponent''' || texture || 1.0 || texture name or constant
|}

===Type: lessthan ===

returns 1 if texture1 < texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lessthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: greaterthan ===

returns 1 if texture1 > texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "greaterthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: shadingnormal ===

Returns the shading normal of the mesh at the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "shadingnormal" || type of texture
|}

===Type: position ===

Returns the position of the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "position" || type of texture
|}

===Type: splitfloat3 ===

Extract a channel from a float3 texture. Can for example be used to get the R, G or B channel of a color texture, or to get the X, Y or Z components of a vector texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "splitfloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.channel''' || int || 0 || the channel to get from the input texture. 0 for first channel, 1 for second, 2 for third channel
|}

===Type: makefloat3 ===

Combine three float textures into one float3 texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "makefloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture3''' || texture || 1.0 || texture name or constant
|}

===Type: blackbody===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blackbody" || type of texture
|-
|'''scene.textures.<texture name>.temperature''' || float || 6500 || emission temperature
|-
|'''scene.textures.<texture name>.normalize''' || bool || false || normalize the output
|}

===Type: irregulardata===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "irregulardata" || type of texture
|-
|'''scene.textures.<texture name>.wavelengths''' || vector || 580.0 620.0 660.0|| wavelenghts
|-
|'''scene.textures.<texture name>.data''' || vector || 0.0 0.000015 0.0|| data (length should match wavelength's length)
|}

===Type: lampspectrum===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lampspectrum" || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || "Daylight" || lamp light spectrum
|}

===Type: Fresnel Textures===

Textures for loading optical data

====Type: fresnelcolor====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelcolor || type of texture
|-
|'''scene.textures.<texture name>.kr''' || vector || 0.5 0.0 0.0 || reflection color
|}

====Type: fresnelpreset====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || aluminium || fresnel preset ("aluminium", "silver", "copper", "gold" or "amorphous carbon")
|}

====Type: fresnelsopra====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Au.nk)
|}

====Type: fresnelluxpop====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Cr.nk)
|}

====Type: distort====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || distort || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0.0 || texture name or constant; input texture
|-
|'''scene.textures.<texture name>.offset''' || texture || 0.0 || texture name or constant; offset to add to the hitpoint coordinates and UV values before evaluating the input texture
|-
|'''scene.textures.<texture name>.strength''' || float || 1.0 || strength multiplier, is multiplied with the offset
|}

==Volumes==

Check [[LuxCoreRender_Volumes|LuxCoreRender Volumes]] for a high level description and examples of the volumes.

All volumes share these properties

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|-
|'''scene.volumes.<volume name>.priority''' || unsigned int|| 0|| volume priority (when volumes overlap, the one with highest priority overrides the others)
|-
|'''scene.volumes.<volume name>.ior''' || texture|| ... || index of refraction
|-
|'''scene.volumes.<volume name>.absorption''' || texture || ... || absorption texture
|-
|'''scene.volumes.<volume name>.emission ''' || texture || ... || emission
|-
|'''scene.volumes.<volume name>.emission.id ''' || unsigned int || ... || emission ID
|}

===Volume: Clear===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|}

===Volume: Homogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || homogeneous|| volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|}

===Volume: Heterogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || heterogeneous || volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|-
|'''scene.volumes.<volume name>.steps.size''' || float || ... || step size
|-
|'''scene.volumes.<volume name>.steps.maxcount''' || unsigned int || ... || step maximum count
|}

==Materials==

Check [[LuxCoreRender_Materials|LuxCoreRender Materials]] for a high level description and examples of the materials.

===Common properties===

Common material properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.bumptex''' || texture || || texture to use for the bump mapping
|-
|'''scene.materials.<material name>.normaltex''' || texture || || texture to use for the normal mapping
|-
|'''scene.materials.<material name>.samples''' || int || -1 || number of rays used to sample this material. -1 means use the default global value. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.diffuse.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.glossy.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.specular.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.bumpsamplingdistance''' || float || 0.001 || set the offset used to sample bump/normal mapping.
|-
|'''scene.materials.<material name>.volume.interior''' || string || vol1 || name of interior volume (for volume rendering)
|-
|'''scene.materials.<material name>.volume.exterior''' || string || vol2 || name of exterior volume (for volume rendering)
|-
|'''scene.materials.<material name>.id''' || int|| ... || material id
|-
|'''scene.materials.<material name>.transparency''' || texture || 1.0 || transparency of the material. 1 for opaque, 0 for fully transparent
|-
|'''scene.materials.<material name>.shadowcatcher.enable''' || bool || false || If true, the material will be transparent where hit by direct light and opaque otherwise (alpha transparency). Used for compositing.
|}

====Normal maps====
Normal maps are set first as a texture type and then assigned to the material. For example:

<blockquote><pre>
scene.textures.normmap.type = imagemap
scene.textures.normmap.file = scenes/bump/normal.png
scene.textures.normmap.gamma = 1

scene.materials.mat_white.type = matte
scene.materials.mat_white.kd = 0.8 0.8 0.8
scene.materials.mat_white.normaltex = normmap
</pre></blockquote>

====Light emission====

All materials can emit light:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.emission''' || texture || 0.0 0.0 0.0 || color of the emitted light
|-
|'''scene.materials.<material name>.emission.gain''' || spectrum || 1.0 1.0 1.0 || multiplier for lamp brigthness
|-
|'''scene.materials.<material name>.emission.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.materials.<material name>.emission.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.materials.<material name>.emission.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light
|-
|'''scene.materials.<material name>.emission.iesblob''' || blob || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.materials.<material name>.emission.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.materials.<material name>.emission.samples''' || int || -1 || the number of shadow ray to trace to compute direct light from this material. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.materials.<material name>.emission.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.
|-
|'''scene.materials.<material name>.emission.theta''' || float || 90.0 || How directional the light is emitted, set as the half-angle of the light source. Default is 90°. Smaller values mean that more light is emitted in the direction of the face normals and less to the sides.
|-
|'''scene.materials.<material name>.emission.importance''' || float || 1.0 || A hint how often to sample this light source compared to other lights
|}

===Type: archglass===

This material should be used to replace glass material of windows when rendering architectural interiors. It allows direct light to pass trough.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "archglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: carpaint===

Car Paint is an advanced glossy material, simulating a diffuse surface with mutliple reflective coatings.

The available presets for the carpaint material are:

*"ford f8"
*"polaris silber"
*"opel titan"
*"bmw339"
*"2k acrylack"
*"white"
*"blue"
*"blue matte"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "carpaint" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "ford f8" || one of the avilable presets
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || absorption color
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || absorption depth
|-
|'''scene.materials.<material name>.kd''' || texture || 0.0 0.0 0.0 || diffuse color
|-
|'''scene.materials.<material name>.ks1''' || texture || 0.0 0.0 0.0 || specular color - layer 1
|-
|'''scene.materials.<material name>.ks2''' || texture || 0.0 0.0 0.0 || specular color - layer 2
|-
|'''scene.materials.<material name>.ks3''' || texture || 0.0 0.0 0.0 || specular color - layer 3
|-
|'''scene.materials.<material name>.r1''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 1
|-
|'''scene.materials.<material name>.r2''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 2
|-
|'''scene.materials.<material name>.r3''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 3
|-
|'''scene.materials.<material name>.m1''' || texture || 0.0 0.0 0.0 || roughness - layer 1
|-
|'''scene.materials.<material name>.m2''' || texture || 0.0 0.0 0.0 || roughness - layer 2
|-
|'''scene.materials.<material name>.m3''' || texture || 0.0 0.0 0.0 || roughness - layer 3
|}

===Type: cloth===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "cloth" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "denim" || denim, silk_charmeuse, silk_shantung, cotton_twill, wool_garbardine or polyester_lining_cloth
|-
|'''scene.materials.<material name>.weft_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in one weave direction
|-
|'''scene.materials.<material name>.weft_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in one weave direction
|-
|'''scene.materials.<material name>.warp_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.warp_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.repeat_u''' || float || 100.0 || thread count in the u direction
|-
|'''scene.materials.<material name>.repeat_v''' || float || 100.0 || thread count in the v direction
|}

===Type: disney===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "disney" || type of material
|-
|'''scene.materials.<material name>.basecolor''' || texture || 0.5 0.5 0.5 || Base color
|-
|'''scene.materials.<material name>.subsurface''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.roughness''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.metallic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.specular''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.speculartint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoat''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoatgloss''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.anisotropic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheen''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheentint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.filmamount''' || texture || none || Linear interpolation between no film (0) and full film effect (1) for artistic control. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.cauchyb''' || texture || 0.0 || if defined and > 0.0, enable dispersion. The value is the B term of the [https://en.wikipedia.org/wiki/Cauchy%27s_equation Cauchy's equation]
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glossy2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossy2" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossytranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossytranslucent" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmission color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.ks_bf''' || texture || 0.5 0.5 0.5 || texture or constant backface specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.uroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.vroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.ka_bf''' || texture || 0.0 0.0 0.0 || texture or constant value of backface coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.d_bf''' || texture || 0.0 || texture or constant value of the backface depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.index_bf''' || texture || 0.0 0.0 0.0 || IOR of the backface coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|-
|'''scene.materials.<material name>.multibounce_bf''' || bool || false || backface simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossycoating===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossycoating" || type of material
|-
|'''scene.materials.<material name>.base''' || string || || name of base material, the coating layer is added on top of this material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: matte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "matte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the matte material
|}

===Type: mattetranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mattetranslucent" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 0.5 0.5 0.5 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmitted color of the material
|}

===Type: metal2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "metal2" || type of material
|-
|'''scene.materials.<material name>.fresnel''' || fresnel texture || ... || [[#Type:_Fresnel_Textures | fresnel texture]]
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.preset''' || string || "aluminium" || (DEPRECATED) "aluminium", "silver", "copper", "gold" or "amorphous carbon"
|-
|'''scene.materials.<material name>.n''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxn texture on overwrite the .preset property
|-
|'''scene.materials.<material name>.k''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxk texture on overwrite the .preset property
|}

===Type: mirror===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mirror" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|}

===Type: mix===

This material can be used to mix 2 other materials.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mix" || type of material
|-
|'''scene.materials.<material name>.material1''' || string || mat1 || name of another material
|-
|'''scene.materials.<material name>.material2''' || string || mat2 || name of another material
|-
|'''scene.materials.<material name>.amount''' || texture || 0.5 || texture or constant value used to mix the materials
|}

===Type: null===

This is empty, not visible material. It can be combined by using mix material with others. It is often used in combination with the alpha channel of an image map to render leafs, etc.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "null" || type of material
|}

===Type: roughglass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: roughmatte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughmatte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the roughmatte material
|-
|'''scene.materials.<material name>.sigma''' || texture || 0.0 || the sigma parameter in the Oren-Nayer shader in degrees. Zero for pure Lambertian reflection
|}

===Type: velvet===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "velvet" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || color of the material's fuzz
|-
|'''scene.materials.<material name>.p1''' || texture || -2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p2''' || texture || 20.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p3''' || texture || 2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.thickness''' || texture || 0.1 || height of the fuzz
|}

==Objects==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.material''' || string || || type of object material
|-
|'''scene.objects.<object name>.shape''' || string || || name of [[#Shapes | shape]] with the triangle mesh description.Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same shape, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.ply''' || string || || '''(Deprecated, use .shape instead)''' name of [http://en.wikipedia.org/wiki/PLY_(file_format) PLY] file with the triangle mesh description. Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same file, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.objects.<object name>.vertices''' || float || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of float values defining the vertices of the mesh (i.e. 3 coordinates for each vertex).
|-
|'''scene.objects.<object name>.faces''' || unsigned int || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of unsigned int values defining the triangles of the mesh (i.e. 3 index of vertices for each triangle).
|-
|'''scene.objects.<object name>.id''' || unsigned int || || object ID
|-
|'''scene.objects.<object name>.camerainvisible''' || bool || false || toggle visibility for camera rays. If set to true, the object will not show up in camera rays, but it will still be visible in reflections, refractions, shadows, indirect light etc.
|}

===Object Motion Blur===

LuxCore supports transformation motion blur for objects.
Motion blur is enabled if an object has a motion system defined as described below.

A motion system consists of steps (at least 2). Each step has a time (in seconds) and a transformation matrix of the object at this point in time.
Step indices start at 0. The times have to be monotonic (each greater than the last).

Note that the embree accelerator only supports a maximum of 129 time steps.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.motion.<step>.time''' || float || || time (in seconds) of the step
|-
|'''scene.objects.<object name>.motion.<step>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix of the object at the given step
|-
|}

==Shapes==

===Type: mesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "mesh" || mesh shape
|-
|'''scene.shapes.<shape name>.ply''' || string || ... || mesh path (e.g ''scenes/luxball/luxball-shell.ply'')
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: inlinedmesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "inlinedmesh" || inlinedmesh shape
|-
|'''scene.shapes.<shape name>.vertices''' || vector || ... || inlinedmesh vertices (e.g 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0 0.0)
|-
|'''scene.shapes.<shape name>.faces''' || vector || ... || inlinedmesh faces (e.g 0 1 2)
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: pointiness===

Contains surface curvature information in vertex alpha channel. 
You can access this information in materials via a hitpointalpha texture. 
The values range from -1 to 1 (float). 
Values from -1 to 0 are concave, while values from 0 to 1 are convex.

[[ Shape:_Pointiness | Examples ]]

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "pointiness" || pointiness shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || pointiness source (a mesh shape)
|}

===Type: strands===

Can be used for hair, fur, grass etc. 
Note that you need to define the camera before defining any strands shapes, because the tesselation process is viewpoint-dependent.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "strands" || strands shape
|-
|'''scene.shapes.<shape name>.file''' || string || ... || strands file (''scenes/strands/straight.hair'')
|}

====Strands tessellation methods====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbon" || ribbon tessellation
|-
|'''scene.shapes.<shape name>.tessellation.usecameraposition''' || bool || 1 || use camera position
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbonadaptive" || ribbon adaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.maxdepth''' || unsigned int || 12 || max tessellation depth
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.error ''' || float || 0.0075 || max tessellation error
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solid" || solid tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solid.sidecount ''' || unsigned int || 12 || tessellation's side count
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solidadaptive" || solidadaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.sidecount ''' || unsigned int || 8 || tessellation's side count
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.maxdepth''' || unsigned int || 16 || tessellation's max depth
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.error''' || float || 0.05 || tessellation's max error
|}

===Type: group===

Todo.

===Type: displacement===

Todo.

===Type: subdiv===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "subdiv" || subdivided shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || source mesh name
|-
|'''scene.shapes.<shape name>.maxlevel''' || unsigned integer || 2 || maximum level of subdivision
|-
|'''scene.shapes.<shape name>.maxedgescreensize''' || float || 0.0 || maximum edge screen size
|-
|'''scene.shapes.<shape name>.adaptive''' || bool || 1 || Adaptive refinement / Uniform refinement
|}

===Type: harlequin===

Todo.

===Type: simplify===

Todo.

===Type: islandaov===

Todo.

===Type: randomtriangleaov===

Todo.

==Light sources==

Check [[Lighting|LuxCoreRender Lighting]] for an high level description and example of the light sources.

===Common parameters===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.gain''' || spectrum || 1.0 1.0 1.0 || intensity of the light
|-
|'''scene.lights.<light name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.lights.<light name>.samples''' || int || -1 || the number of shadow ray to trace to compute direct light for this light source. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.

|-
|'''scene.lights.<light name>.importance''' || float || 1.0 || A hint how often to sample this light compared to other lights
|}

===Type: sun===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sun" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.relsize''' || float || 1.0 || relative size to the sun
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sky2===

Hosek-Wilkie sky model.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sky2" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.gain''' || vector || ... || gain
|-
|'''scene.lights.<light name>.groundalbedo''' || vector || 0.5 0.5 0.5 || ground albedo
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.ground.enable''' || bool || 1 || enable ground color
|-
|'''scene.lights.<light name>.ground.color''' || vector|| ... || RGB ground color
|}

===Type: infinite===

Spherical lightsource surrounding the scene at infinite distance. 
Used for image based lighting (IBL) and HDR environment lighting if the file is a high dynamic range image.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "infinite" || type of light
|-
|'''scene.lights.<light name>.file''' || string || "image.png" || filename of the environment map
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma correction used by the image map
|-
|'''scene.lights.<light name>.storage''' || string || "auto" || environment map storage type ("auto", "byte", "half" or "float")
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.sampleupperhemisphereonly''' || bool || false || an option set to black the lower hemisphere. Mostly useful for shadow catchers.
|}

===Type: point===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "point" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mappoint===

Point light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mappoint" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: sphere===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mapsphere===

Sphere light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mapsphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: spot===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "spot" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.coneangle''' || float || 30.0 || angle in degrees of the spotlight cone
|-
|'''scene.lights.<light name>.conedeltaangle''' || float || 5.0 || angle at which the spotlight intensity starts to fade from the edge
|}

===Type: projection===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "projection" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.fov''' || float || 45.0 || field of view in terms of angular spread along the shorter image axis
|-
|'''scene.lights.<light name>.mapfile''' || string || || filename of the image to project. If not specified, a constat light color will be used.
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|}

===Type: constantinfinite===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "constantinfinite" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sharpdistant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sharpdistant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|}

===Type: distant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "distant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|-
|'''scene.lights.<light name>.theta''' || float || 10.0 || half angle of the light source in degree. Must be > 0 for soft shadows
|}

===Type: laser===

A light source emitting parallel light rays (like sharpdistant light, but starting inside the scene instead of infinitely far away).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "laser" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.radius''' || float || 0.01 || radius of the laser beam
|}

LuxCore SDL Reference Manual v2.11

2026-06-07T10:20:09Z

CodeHD: /* Camera */

The scene description language (SDL) is used to configure the renderer and to define objects, materials, textures etc. in the scene. 
The file ending of the render configuration file is ".cfg", for the scene file it's ".scn".

These files are usually created by exporter plugins, e.g. BlendLuxCore. 
This wiki page is primarily a reference for exporter developers, normal end-users should not need to edit cfg/scn files by hand.

Sometimes the API is updated faster than the wiki, in this case you can look at the code directly: https://github.com/LuxCoreRender/LuxCore/tree/master/src/slg/scene

Note that matrices are passed as flat lists in column-major form.

=Render configuration file=

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''resumerendering.filesafe''' || bool || 1 || enable/disable "safe save" mode for resume rendering file. A backup of the output is always valid even in the case of a system failure
|}

==Seed==

The global seed value that is used to generate random numbers. 
Two images rendered with the same seed will have the same noise pattern.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.seed''' || unsigned int || 1 || min 1
|}

==Periodic save==

Options related to periodic save operations.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''periodicsave.resumerendering.period''' || float || 0 || save the resume rendering file every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.resumerendering.filename''' || string || "resume.rsm" || the name to use to save the rendering resume information periodically
|-
|'''periodicsave.film.period''' || float || 0 || save the Film every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.film.filename''' || string || "film.flm" || the name to use to save the film periodically
|-
|'''periodicsave.film.outputs.period''' || float || 600 || save all Film outputs every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|}

==Render Engine==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.type''' || string || "PATHCPU" || engine type
|}

=== CPU Render Engines ===

CPU render engines are written in C++ and don't require OpenCL. All CPU render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''native.threads.count''' || int || CPU core count || > 0 || > 0 || The number of threads will be used for the rendering
|}

'''The following CPU engines are available:'''

===="PATHCPU"====

A path tracer with full image plane rendering (i.e. supporting Metropolis sampler).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|}

===="TILEPATHCPU"====
Biased path tracer with many control options and support for tile rendering. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|-
|'''tilepath.sampling.aa.size''' || int || 3 || > 0 || [1, 13] || All diffuse/glossy/specular samples are multiplied with the squared aa size: final_samples = aa^2 * (diffuse^2 + glossy^2 + specular^2)
|-
|'''tile.size''' || int || 32 || ≥ 8 || [8, 256] || Tile size in pixels
|-
|'''tile.multipass.enable''' || bool || 1 || 0 or 1 || o or 1 || Re-render the image until a halt threshold is met or indefinitely
|-
|'''tile.multipass.convergencetest.threshold''' || float || 6.0 / 256.0 || > 0.0 || [1.0 / 256.0, 6.0 / 256.0] || Target noise level
|-
|'''tile.multipass.convergencetest.threshold.reduction''' || float || 0.0 || [0.0, 1.0] || [0.75, 0.95] || Multiply noise level with this number when all tiles have met the previous noise level. Set to 0 to disable (so rendering will stop at the noise level)
|-
|'''tile.multipass.convergencetest.warmup.count''' || int || 32 || ≥ 0 || [8, 128] || Warm up period for the convergence test expressed in samples per pixel
|}

===="BIDIRCPU"====

A Bidirectional path tracer.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a eye path
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

===="RTPATHCPU"====
Engine optimized for interactive scene editing and camera movement. 
The sampler must be set to RTPATHCPUSAMPLER when using this engine.

Supports the same properties as [[#"PATHCPU" | "PATHCPU"]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpathcpu.zoomphase.size''' || int || 4 || || || render scaled down film for the first few frames after a scene edit (to make interactions more fluid)
|-
|'''rtpathcpu.zoomphase.weight''' || float || 0.1 || || || description: TODO
|}

=== OpenCL Render Engines ===

OpenCL engines can run on GPUs, CPUs and other types of computing devices, they require OpenCL to run. All OpenCL render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''opencl.platform.index''' || int || -1 || A valid platform index || -1 || Select the OpenCL platform to use. All devices available on all platforms will be used with -1
|-
|'''opencl.cpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL CPU devices available
|-
|'''opencl.gpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL GPU devices available
|-
|'''opencl.cpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.gpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.devices.select''' || string || "" || Any valid selection string || Any valid selection string || Select each OpenCL device to use. It is a string of "0" and "1". "1" means use the device, "0" do not
|}

'''The following OpenCL engines are available:'''

===="PATHOCL"====
OpenCL version of PATHCPU. Supports the same settings as [[#"PATHCPU" | PATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''pathocl.pixelatomics.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable pixel atomic operation
|-
|'''opencl.task.count''' || int || "AUTO" || "AUTO" or > 0 || [64K, 1024K] || The number of tasks sent to the OpenCL device in one kernel call
|}

===="RTPATHOCL"====

A PATHOCL version optimized for real-time rendering with fixed frame-rate and variable quality. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"PATHOCL" | PATHOCL]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpath.resolutionreduction.preview''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels in the first passes. For instance 4x4 than 2x2 and than always 1x1
|-
|'''rtpath.resolutionreduction.preview.step''' || int || 8 || > 0 || [1, 32] || Each preview step is rendered for n frames
|-
|'''rtpath.resolutionreduction''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels, outside the preview phase, in order to reduce the per frame rendering time
|}

===="TILEPATHOCL"====

OpenCL version of TILEPATHCPU. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"TILEPATHCPU" | TILEPATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''tilepathocl.devices.maxtiles''' || int || 16 || ≥ 1 || [1, 32] || Maximum number of tiles to send in a single call to each OpenCL device
|}

==="FILESAVER"===

Saves everything needed to render the scene to the output path, including textures and meshes.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''filesaver.format''' || string || "TXT" || "TXT" for a text SDL format and "BIN" for a single file binary format
|-
|'''filesaver.filename''' || string || "luxcore-exported-scene.bcf" || file name for "BIN" format
|-
|'''filesaver.directory''' || string || "luxcore-exported-scene" || output path for "TXT" format
|-
|'''filesaver.renderengine.type''' || string || "PATHCPU" || render engine to use when rendering the scene after it was saved with FILESAVER. Any engine string from above can be used here.
|}

===Experimental and debugging engines===

'''These engines are experimental, deprecated or are only intended for very specific purposes:'''

===="BIDIRVMCPU"====

Bidir with vertex merging, currently experimental. 
Supports the same settings as [[#"BIDIRCPU" | BIDIRCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''bidirvm.lightpath.count''' || int || 16 * 1024 || > 0 || || Number of lightpaths per pass
|-
|'''bidirvm.startradius.scale''' || float || 0.003 || > 0 || || Photon radius of the first pass
|-
|'''bidirvm.alpha''' || float || 3 || > 0 || [0.0, 1.0] || Photon radius is multiplied with this value after every pass to reduce the radius
|}

===="LIGHTCPU"====

For testing.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''light.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''light.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

==Sampler==

Samplers are used by following render engines:

* LIGHTCPU
* PATHCPU
* BIDIRCPU
* BIDIRVMCPU
* PATHOCL

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''sampler.type''' || string || "SOBOL" || sampler type
|}

The following samplers are available:

==="SOBOL"===

Sampler with sobol pattern.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.sobol.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==="METROPOLIS"===

Metropolis sampler.
Parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.metropolis.largesteprate''' || float || 0.4 || 0 ≤ x ≤ 1 || 0 - 1 || Probability of generating a large sample mutation
|-
|'''sampler.metropolis.maxconsecutivereject''' || int || 512 || x ≥ 0 || 0 - 32768 || Number of consecutive rejects before a next mutation is forced. Low values can cause bias
|-
|'''sampler.metropolis.imagemutationrate''' || float || 0.1 || 0 ≤ x ≤ 1 || 0 - 1 || Maximum distance over the image plane for a small mutation
|}

==="RANDOM"===

Fully random sampler. This sampler is mostly intended for testing purpose.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.random.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==Filter==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.type''' || string || "BLACKMANHARRIS" || || || Type of pixel filter.
|-
|'''film.filter.width''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Filter radius in pixels. Does not have an effect on the NONE filter
|-
|'''film.filter.xwidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|-
|'''film.filter.ywidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|}

Available filters are:

==="NONE"===

Disable pixel filtering.

==="BOX"===

Box pixel filter. No parameters.

==="GAUSSIAN"===

Gaussian pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.gaussian.alpha''' || float || 2.0 || x > 0.0 || 0.1 - 10.0 || Gaussian rate of falloff. Lower values give blurrier images.
|}

==="MITCHELL"===

Mitchel pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchell.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchell.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="MITCHELL_SS"===

Mitchel pixel filter with super-sampling (i.e. image will be filtered first with a grid of 4 pixels for each pixel).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchellss.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchellss.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="BLACKMANHARRIS"===

Blcakman-Harris pixel filter. No parameters.

==Light Strategy==

The direct light sampling strategy is defined by the following property:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.type''' || string || "LOG_POWER" || "UNIFORM", "POWER", "LOG_POWER" or "DLS_CACHE" || N/A || Direct light sampling strategy
|}

==="UNIFORM"===

"UNIFORM" light strategy samples evenly all light sources.

==="POWER"===

"POWER" light strategy samples the light sources based on their power.

==="LOG_POWER"===

"LOG_POWER" light strategy samples the light sources based on logarithm of their power.

==="DLS_CACHE"===

Build direct light sampling cache to optimize many-lights rendering, beneficial in scenes with multiple light sources with few overlap between their influence areas (e.g. a building with many disconnected rooms and interior lights).

Options for the DLS cache:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.entry.radius''' || float || 0.0 || || N/A || Entry radius in meters, automatic radius estimation is used if the radius is set to 0
|-
|'''lightstrategy.entry.normalangle''' || float || 25.0 || || N/A ||
|-
|'''lightstrategy.entry.maxpasses''' || int || 1024 || || N/A ||
|-
|'''lightstrategy.entry.convergencethreshold''' || float || 0.05 || || N/A ||
|-
|'''lightstrategy.entry.warmupsamples''' || int || 24 || || N/A ||
|-
|'''lightstrategy.targetcachehitratio''' || float || 0.995 || || N/A ||
|-
|'''lightstrategy.maxdepth''' || int || 4 || || N/A ||
|-
|'''lightstrategy.maxsamplescount''' || int || 10000000 || || N/A ||
|-
|'''lightstrategy.persistent.file''' || string || "" || || N/A ||
|-
|'''lightstrategy.persistent.safesave''' || bool || 1 || || N/A ||

|}

==Accelerator==

The ray/triangle intersection accelerator to use for the rendering is defined by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''accelerator.type''' || string || "AUTO" || "AUTO", "BVH", "MBVH", "EMBREE" || "AUTO" || The intersection accelerator. "AUTO" will select the best one available for the current [[LuxRays]] intersection device. "EMBREE" is currently usable only on CPU render engines
|-
|'''accelerator.instances.enable''' || bool || 1 || 0 or 1 || 0 or 1 || Enable instance support (or disable in order to slightly increase rendering speed)
|}

==Epsilon==

Minimum and maximum allowed value for scene epsilon can be define by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''scene.epsilon.min''' || float || 1e-5f || Any float value || 1e-6f ≤ x ≤ 1e-1f || Minimum allowed value for scene epsilon
|-
|'''scene.epsilon.max''' || float || 1e-1f || Any float value || 1e-3f ≤ x ≤ 1e+2f || Maximum allowed value for scene epsilon
|}

==Film==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.safesave''' || bool || 1 || enable "safe save" of Film serialization. A backup of the output is always valid even in the case of a system failure.
|}

===Film OpenCL Options===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.opencl.enable''' || bool || 1 || enable OpenCL film operations
|-
|'''film.opencl.platform''' || unsigned int || -1 || choose which platform will be used by the film operations. (0 is first platform, 1 second and so on. -1 for all)
|-
|'''film.opencl.device''' || unsigned int || -1 || choose which device will be used by the film operations. (0 is first device, 1 second and so on. -1 for first GPU device)
|}

===Film Outputs (aka AOVs)===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.safesave''' || bool || 1 || enable "safe save" for Film outputs. A backup of the output is always valid even in the case of a system failure
|}

The film object supports many types of outputs (aka AOVs). The complete list of supported output types:

{| class="wikitable" cellspacing="2"
!Name
!Type
|-
|'''RGB''' || HDR
|-
|'''RGBA''' || HDR
|-
|'''RGB_IMAGEPIPELINE''' || HDR/LDR
|-
|'''RGBA_IMAGEPIPELINE''' || HDR/LDR
|-
|'''ALPHA''' || HDR/LDR
|-
|'''DEPTH''' || HDR
|-
|'''POSITION''' || HDR
|-
|'''GEOMETRY_NORMAL''' || HDR
|-
|'''SHADING_NORMAL''' || HDR
|-
|'''MATERIAL_ID''' || LDR
|-
|'''DIRECT_DIFFUSE''' || HDR
|-
|'''DIRECT_GLOSSY''' || HDR
|-
|'''EMISSION''' || HDR
|-
|'''INDIRECT_DIFFUSE''' || HDR
|-
|'''INDIRECT_GLOSSY''' || HDR
|-
|'''INDIRECT_SPECULAR''' || HDR
|-
|'''MATERIAL_ID_MASK''' || HDR/LDR
|-
|'''DIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''INDIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''RADIANCE_GROUP''' || HDR/LDR
|-
|'''UV''' || HDR/LDR
|-
|'''RAYCOUNT''' || HDR/LDR
|-
|'''BY_MATERIAL_ID''' || HDR/LDR
|-
|'''IRRADIANCE''' || HDR
|-
|'''OBJECT_ID''' || LDR
|-
|'''OBJECT_ID_MASK''' || HDR/LDR
|-
|'''BY_OBJECT_ID''' || HDR/LDR
|-
|'''SAMPLECOUNT''' || HDR/LDR
|-
|'''CONVERGENCE''' || HDR/LDR
|-
|'''NOISE''' || HDR/LDR
|-
|'''SERIALIZED_FILM''' || N/A
|-
|'''MATERIAL_ID_COLOR''' || HDR/LDR
|}

Outputs are enabled with the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.<index>.type''' || string || || Type of output, e.g. "RGBA" or "ALPHA" (see the list above for the available types)
|-
|'''film.outputs.<index>.filename''' || string || || Filename to use when saving the output. The filename should use ".exr" as extension for HDR outputs and ".png" for LDR outputs (see list above for which output is HDR and which LDR)
|-
|'''film.outputs.<index>.id''' || int || || Specify for the following outputs: '''MATERIAL_ID_MASK''', '''RADIANCE_GROUP''', '''BY_MATERIAL_ID''', '''OBJECT_ID_MASK''', '''BY_OBJECT_ID''' (to choose the object ID, material ID or radiance group ID of the output)
|-
|'''film.outputs.<index>.index''' || int || || Specify for an imagepipeline output (RGB_IMAGEPIPELINE or RGBA_IMAGEPIPELINE) to select the imagepipeline of the output. For example, if you have 3 imagepipelines defined, and you want to specify the output of the third imagepipeline, use 2 for the ".index" property of the output
|}

Note that the Bidir engine does not support all AOVs.
Not supported by Bidir are: EMISSION, DIRECT_DIFFUSE, DIRECT_GLOSSY, INDIRECT_DIFFUSE, INDIRECT_GLOSSY, INDIRECT_SPECULAR, DIRECT_SHADOW_MASK, INDIRECT_SHADOW_MASK, IRRADIANCE, RAYCOUNT.

This is the list of output channel data types and sizes:

{| class="wikitable" cellspacing="2"
!Output type
!Data type
!Size
!Description
|-
|RGB||float||film width x film height x 3||R, G, B
|-
|RGB_IMAGEPIPELINE||float||film width x film height x 3||R, G, B
|-
|RGBA||float||film width x film height x 4||R, G, B, A
|-
|ALPHA||float||film width x film height x 1||Alpha value [0, 1]
|-
|DEPTH||float||film width x film height x 1||Camera distance
|-
|POSITION||float||film width x film height x 3||World X, Y, Z
|-
|GEOMETRY_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|SHADING_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|DIRECT_DIFFUSE||float||film width x film height x 3||Diffuse R, G, B
|-
|DIRECT_GLOSSY||float||film width x film height x 3||Glossy R, G, B
|-
|EMISSION||float||film width x film height x 3||Emission R, G, B
|-
|INDIRECT_DIFFUSE||float||film width x film height x 3||Indirect diffuse R, G, B
|-
|INDIRECT_GLOSSY||float||film width x film height x 3||Indirect glossy R, G, B
|-
|INDIRECT_SPECULAR||float||film width x film height x 3||Indirect specular R, G, B
|-
|MATERIAL_ID_MASK||float||film width x film height x 1||Material mask [0, 1]
|-
|DIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|INDIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|RADIANCE_GROUP||float||film width x film height x 3||R, G, B
|-
|UV||float||film width x film height x 2||Texture coordinates U, V
|-
|RAYCOUNT||float||film width x film height x 1||Ray count
|-
|BY_MATERIAL_ID||float||film width x film height x 3||By material ID
|-
|MATERIAL_ID||uint||film width x film height x 1||Material ID
|-
|IRRADIANCE||float||film width x film height x 3||R, G, B
|-
|OBJECT_ID_MASK||float||film width x film height x 1||Object mask [0, 1]
|-
|BY_OBJECT_ID||float||film width x film height x 3||By object ID
|-
|OBJECT_ID||uint||film width x film height x 1||Object ID
|-
|SAMPLECOUNT||uint||film width x film height x 1||Sample count
|-
|CONVERGENCE||float||film width x film height x 1||The distance of each pixel from the convergence threshold
|-
|NOISE||float||film width x film height x 1||The noise estimated for each pixel
|-
|SERIALIZED_FILM||N/A||N/A||The complete Film serialized in binary format
|-
|MATERIAL_ID_COLOR||float||film width x film height x 3||Material ID converted to colors (with anti-aliasing)
|}

===Film Channels===

Film channels are implicitly enabled by declaring film outputs (even if the output is never used). For instance, declaring a "RGBA" output will automatically enable "RADIANCE_PER_PIXEL_NORMALIZED" (and "RADIANCE_PER_SCREEN_NORMALIZED" for BIDIRCPU) and "ALPHA".
The supported channels are:

{| class="wikitable" cellspacing="2"
!Channel type
!Data type
!Size
!Last element is weight ?
!Note
|-
|CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED||float||film width x film height x 4||Yes||One for each radiance group. Eye paths radiance.
|-
|CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED||float||film width x film height x 3||No||One for each radiance group. Light paths radiance. Used only by LIGHTCPU and BIDIRCPU.
|-
|CHANNEL_ALPHA||float||film width x film height x 2||Yes||
|-
|CHANNEL_RGB_IMAGEPIPELINE||float||film width x film height x 3||No||
|-
|CHANNEL_DEPTH||float||film width x film height x 1||No||
|-
|CHANNEL_POSITION||float||film width x film height x 3||No||
|-
|CHANNEL_GEOMETRY_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_SHADING_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_MATERIAL_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_DIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_DIRECT_GLOSSY||float||film width x film height x 4||Yes||
|-
|CHANNEL_EMISSION||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_SPECULAR||float||film width x film height x 4||Yes||
|-
|CHANNEL_MATERIAL_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_DIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_INDIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_UV||float||film width x film height x 2||No||
|-
|CHANNEL_RAYCOUNT||float||film width x film height||No||
|-
|CHANNEL_BY_MATERIAL_ID||float||film width x film height x 4||Yes||
|-
|CHANNEL_IRRADIANCE||float||film width x film height x 4||Yes||
|-
|CHANNEL_OBJECT_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_OBJECT_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_BY_OBJECT_ID||float||film width x film height x 4||Yes||
|}

This is the list of channels enabled by each output:

{| class="wikitable" cellspacing="2"
!Output
!Enabled channels
|-
|'''RGB''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''RGB_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''ALPHA''' || ALPHA
|-
|'''DEPTH''' || DEPTH
|-
|'''POSITION''' || DEPTH, POSITION
|-
|'''GEOMETRY_NORMAL''' || DEPTH, GEOMETRY_NORMAL
|-
|'''SHADING_NORMAL''' || DEPTH, SHADING_NORMAL
|-
|'''MATERIAL_ID''' || DEPTH, MATERIAL_ID
|-
|'''DIRECT_DIFFUSE''' || DIRECT_DIFFUSE
|-
|'''DIRECT_GLOSSY''' || DIRECT_GLOSSY
|-
|'''EMISSION''' || EMISSION
|-
|'''INDIRECT_DIFFUSE''' || INDIRECT_DIFFUSE
|-
|'''INDIRECT_GLOSSY''' || INDIRECT_GLOSSY
|-
|'''INDIRECT_SPECULAR''' || INDIRECT_SPECULAR
|-
|'''MATERIAL_ID_MASK''' || MATERIAL_ID, MATERIAL_ID_MASK
|-
|'''DIRECT_SHADOW_MASK''' || DIRECT_SHADOW_MASK
|-
|'''INDIRECT_SHADOW_MASK''' || INDIRECT_SHADOW_MASK
|-
|'''RADIANCE_GROUP''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''UV''' || DEPTH, UV
|-
|'''RAYCOUNT''' || DEPTH, RAYCOUNT
|-
|'''BY_MATERIAL_ID''' || BY_MATERIAL_ID
|-
|'''IRRADIANCE''' || IRRADIANCE
|-
|'''OBJECT_ID''' || DEPTH, OBJECT_ID
|-
|'''OBJECT_ID_MASK''' || OBJECT_ID, OBJECT_ID_MASK
|-
|'''BY_OBJECT_ID''' || BY_OBJECT_ID
|}

Note: CHANNEL_RGB_IMAGEPIPELINE is always enable and the result of running the image pipeline.

===Image pipeline===

It is possible to define multiple image pipelines at the same time by using the '''film.imagepipelines.<pipeline #>.''' properties prefix. Each image pipeline takes as input the raw rendering and is a chain off image pipeline plugins. Each plugin receives previous plugin output and produces a new output.

====Radiance Group====

Radiance groups are used to get only the contribution of a group of lights in the scene. 
Lights can be grouped by setting their [[#Common_parameters | '''.id''']] property to the same number, on materials this is done with the [[#Light_emission | '''.emission.id''']] property. 

Note that the OpenCL engines only support up to 8 radiance groups (one of them is the default group).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.globalscale''' || float|| 1 || global weighting of radiance group
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.temperature ''' || float || 6500.0 || light temperature
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.rgbscale''' || vector || 1.0 1.0 1.0 || light color
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.radiancescales.<id>.enabled''' || bool || 1 || enable radiance group
|}

====Image pipeline plug-ins====

=====Type: TONEMAP_LINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || linear tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 1.0 || tonemapping scale
|}

=====Type: TONEMAP_REINHARD02=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_REINHARD02" || reinhard tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.prescale''' || float || 1.0 || reinhard prescale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.postscale''' || float || 1.2 || reinhard postscale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.burn''' || float || 3.75 || reinhard burn
|}

=====Type: TONEMAP_AUTOLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_AUTOLINEAR" || automatic linear tonemapping
|}

=====Type: TONEMAP_LUXLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LUXLINEAR" || linear tonemapping with real camera settings
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sensitivity''' || float || 100.0 || ISO sensitivity
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.exposure''' || float || 0.001 || exposure time
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.fstop''' || float || 2.8 || f/aperture
|}

=====Type: NOP=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipeline.<pipeline #>.<plugin #>.type''' || string || "NOP" || no parameters tonemapper
|}

=====Type: GAMMA_CORRECTION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || gamma correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.value''' || float || 2.2 || gamma value
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.table.size''' || unsigned int || 4096 || resolution
|}

=====Type: OUTPUT_SWITCHER=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OUTPUT_SWITCHER" || overwrite output
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.channel''' || string || "DEPTH" || channel whose values are used to overwrite
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.index''' || unsigned int || 0 || index
|}

=====Type: GAUSSIANFILTER_3x3=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "GAUSSIANFILTER_3x3" || gaussian filter
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.15 || blurring weight
|}

=====Type: CAMERA_RESPONSE_FUNC=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || CAMERA_RESPONSE_FUNC || analog camera film simulation
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.name''' || string || "Advantix_100CD" || film type
|}

=====Type: BACKGROUND_IMG=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || BACKGROUND_IMG || show the background image where alpha < 1 (simple compositing)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || ... || background image path (e.g scenes/simple-mat/sky.exr)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.gamma''' || float || 2.2 || background image gamma
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.storage ''' || string || auto || background image storage type
|}
Note: When the size of the background image differs from the film size, it will be stretched to fit the film size.

=====Type: BLOOM=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "BLOOM" || bloom effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.radius''' || float || 0.07 || how large the bloom effect is in % of the image size (i.e. 1.0 = all image)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.25 || how strong the effect is (i.e. 0.0 = nothing, 1.0 = max. strength)
|}

=====Type: VIGNETTING=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "VIGNETTING" || vignetting effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 0.4 || vignetting strength
|}

=====Type: COLOR_ABERRATION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_ABERRATION" || color aberration effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || color aberration amount
|}

=====Type: MIST=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "MIST" || aerial perspective effect (fake fog)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.color''' || spectrum|| [1, 1, 1] || mist color
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || mist amount
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.startdistance''' || float || 0 || distance from camera until where the mist effect has zero effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.enddistance''' || float || 10000 || distance from camera from where the mist effect has maximum effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.excludebackground''' || bool || false || Do not apply mist effect on pixels with infinite distance to the camera
|}

=====Type: CONTOUR_LINES=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "CONTOUR_LINES" || contour lines for IRRADIANCE AOV
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.range''' || float|| ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.steps''' || int || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.zerogridsize''' || int || ? || ?
|}

=====Type: WHITE_BALANCE =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "WHITE_BALANCE" || White temperature correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.temperature''' || unsigned int|| 6500 || Target image temperature in Kelvin
|-
|}

=====Type: COLOR_LUT =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_LUT" || Applies .cube LUT (look-up-table) to the input
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || "lut.cube" || Filepath to a [https://wwwimages2.adobe.com/content/dam/acom/en/products/speedgrade/cc/pdfs/cube-lut-specification-1.0.pdf .cube LUT file]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.strength''' || float || 1.0 || Linear interpolation between input (0.0) and output (1.0) of the plugin
|-
|}

=====Type: INTEL_OIDN =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "INTEL_OIDN" || Denoises the image using [https://github.com/OpenImageDenoise/oidn Intel OIDN]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.filter.type''' || string || "RT" ||
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.oidnmemory''' || int || 6000 || Approximate maximum amount of memory to use in megabytes (actual memory usage may be higher). Limiting memory usage may cause slower denoising due to internally splitting the image into overlapping tiles
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

=====Type: OPTIX_DENOISER =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OPTIX_DENOISER" || Denoises the image using the Nvidia OptiX denoiser
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.minspp''' || unsigned int || 0 || Minimum amount of samples to be rendered before the plugin is run (at lower sample numbers, it does not modify the input)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

===Film Subregion===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.subregion''' || vector || ... || <xstart> <xstop> <ystart> <ystop>
|}

===Rendering halt conditions===

By default, a LuxCore rendering will never stop however you can enable one or multiple halt conditions:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''batch.haltnoisethreshold''' || float || -1.0 || enable image convergence test and stops when the error is under the defined value. Use a value like "n / 256.0" where n is the level of error you are looking for. It may be hard to achieve a level of error smaller than 3.0 / 256.0. -1.0 disables the halt condition.
|-
|'''batch.haltnoisethreshold.warmup''' || unsigned int || 64 || number of average samples per pixel before to start the convergence test
|-
|'''batch.haltnoisethreshold.step''' || unsigned int || 64 || number of average samples per pixel between two tests
|-
|'''batch.haltnoisethreshold.filter.enable''' || bool || 1 || if the CONVERGENCE AOV (generated by the batch.haltnoisethreshold) should be filtered or not with a 3x3 box filter
|-
|'''batch.haltnoisethreshold.stoprendering.enable''' || bool || 1 || Set this to 0 (false) if you only want to use the haltnoisethreshold settings for adaptive sampling in an endless render
|-
|'''batch.haltnoisethreshold.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for stopping
|-
|'''batch.halttime''' || float || 0.0 || number of seconds before stopping the rendering
|-
|'''batch.haltspp''' || unsigned int || 0 || number of average samples per pixel before stopping the rendering
|}

===Noise estimation===

Image noise can be estimated and its result can be used to drive the Sobol and Random samplers to focus its sampling in the noisier regions.
Setting any of these properties will enable the noise estimation.
The adaptiveness strength is a Sampler property.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.noiseestimation.warmup''' || unsigned int || 32 || number of average samples per pixel before to start the convergence test
|-
|'''film.noiseestimation.step''' || unsigned int || 32 || number of average samples per pixel between two tests
|-
|'''film.noiseestimation.filter.scale''' || unsigned int || 4 || Box filter scale used to filter the NOISE AOV (generated by the noise estimation). Set to 0 to disable.
|-
|'''film.noiseestimation.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for adaptive sampling
|-
|}

=Scene file=

==Camera==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.type''' || string || "perspective" || "perspective", "orthographic", "environment" (360° panorama mapped in latlong format) or "stereo"
|-
|'''scene.camera.lookat.orig''' || point (float float float) || 0.0 10.0 0.0 || camera location
|-
|'''scene.camera.lookat.target''' || point (float float float) || 0.0 0.0 0.0 || camera target
|-
|'''scene.camera.up''' || vector (float float float) || (0.0, 0.0, 1.0) || camera up vector
|-
|'''scene.camera.fieldofview''' || float || 45.0 || field of view
|-
|'''scene.camera.shutteropen''' || float || 0.0 || camera shutter open time (used for motion blur)
|-
|'''scene.camera.shutterclose''' || float || 0.0 || camera shutter close time (used for motion blur)
|-
|'''scene.camera.autovolume.enable''' || bool || true || try automatically to discover scene.camera.volume
|-
|'''scene.camera.volume''' || string || || the initial volume rays will travel in
|-
|'''scene.camera.cliphither''' || float || 1e-3 || TBD
|-
|'''scene.camera.clipyon''' || float || 1e30 || TBD
|-
|'''scene.camera.screenwindow''' || list (float float float float) || 0.0 1.0 0.0 1.0 || <xstart> <xstop> <ystart> <ystop> (Only for "perspective"/"orthographic"/"environment")
|-
|'''scene.camera.bokeh.distribution.type''' || string || NONE || "NONE", "UNIFORM", "EXPONENTIAL", "INVERSEEXPONENTIAL", "GAUSSIAN", "INVERSEGAUSSIAN", "TRIANGULAR", "CUSTOM" (Only for "perspective")
|-
|'''scene.camera.bokeh.blades''' || int || 0 || Number of aperture blades (Only for "perspective")
|-
|'''scene.camera.bokeh.power''' || int || 3 || Distribution factor, only for "EXPONENTIAL" and "INVERSEEXPONENTIAL" types (Only for "perspective")
|-
|'''scene.camera.bokeh.distribution.image''' || string || "image.png" || only if type == "CUSTOM" (Only for "perspective")
|-
|'''scene.camera.bokeh.scalex''' || float || 1.0 || TBD (Only for "perspective")
|-
|'''scene.camera.bokeh.scaley''' || float || 1.0 || TBD (Only for "perspective")
|-
|'''scene.camera.stereo.type''' || string || "perspective" || "perspective", "environment_180", "environment_360"
|-
|'''scene.camera.eyesdistance''' || float || 0.0626 || TBD (Only for "stereo")
|-
|'''scene.camera.lensdistance''' || float || 0.2779 || TBD (Only for "stereo")
|-
|'''scene.camera.oculusrift.barrelpostpro.enable''' || bool || false || TBD (Only for "perspective"/"stereo")
|-
|'''scene.camera.environment.degrees''' || float || 360.0 || TBD (Only for "environment")
|-
|'''scene.camera.lensradius''' || float || 0.0 || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.focaldistance''' || float || 10.0 || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.autofocus.enable''' || bool || false || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.enable''' || bool || false || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.center''' || point (float float float) || 0.0 0.0 0.0 || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.normal''' || vector (float float float) || 0.0 0.0 0.0 || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|}

The camera supports motion blur. See [[ LuxCore_SDL_Reference_Manual_v2.0#Object_Motion_Blur | Object Motion Blur ]]. 
(Only difference being that instead of the prefix '''scene.objects.<object name>''', the prefix '''scene.camera''' is used when setting motion properties of the camera)

==Textures==

Check [[LuxCoreRender_Textures|LuxCoreRender Textures]] for a high level description and examples of the textures.

===Mapping===

Some texture (mostly procedural textures) supports 2D or 3D mapping parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping2d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.rotation''' || float || 0.0 || UV rotation (in degrees)
|-
|'''scene.textures.<texture name>.mapping.uvscale''' || UV || 1.0 1.0 || UV scale
|-
|'''scene.textures.<texture name>.mapping.uvdelta''' || UV || 0.0 0.0 || UV translation
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "globalmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

===Type: add===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "add" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: subtract===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "subtract" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: band===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "band" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5|| texture name or constant
|-
|'''scene.textures.<texture name>.interpolation''' || string || "linear"|| "linear", "cubic" or "none"
|-
|'''scene.textures.<texture name>.offset[0..n]''' || float || 0.0 || multiple offsets in the range of [0.0, 1.0]
|-
|'''scene.textures.<texture name>.value[0..n]''' || spectrum || 1.0 1.0 1.0 || a value for each offset
|}

===Type: blender_blend===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_blend" || type of texture
|-
|'''scene.textures.<texture name>.progressiontype''' || string || "linear" || linear, quadratic, easing, diagonal, spherical, quadratic_spherical, halo or radial
|-
|'''scene.textures.<texture name>.direction''' || string || "horizontal" || horizontal or vertical
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_clouds===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_clouds" || type of texture
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || hard_noise or soft_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_distortednoise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_distortednoise" || type of texture
|-
|'''scene.textures.<texture name>.noise_distortion''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.distortion''' || float || 1 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_magic===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_magic" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_marble===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_marble" || type of texture
|-
|'''scene.textures.<texture name>.marbletype''' || string || "soft" || soft, sharp or sharper
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_musgrave===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_musgrave" || type of texture
|-
|'''scene.textures.<texture name>.musgravetype''' || string || "multifractal" || multifractal, ridged_multifractal, hybrid_multifractal, fBM or hetero_terrain
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.dimension''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.lacunarity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.offset''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.octaves''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_noise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_noise" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_stucci===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_stucci" || type of texture
|-
|'''scene.textures.<texture name>.stuccitype''' || string || "plastic" || plastic, wall_in or wall_out
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_wood===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || bands, rings, bandnoise or ringnoise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_voronoi===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_voronoi" || type of texture
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.distmetric''' || string || "actual_distance" || actual_distance, distance_squared, manhattan, chebychev, minkowski_half, minkowski_four or minkowski
|-
|'''scene.textures.<texture name>.w1''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.w2''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w3''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w4''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: brick===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "brick" || type of texture
|-
|'''scene.textures.<texture name>.bricktex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.mortartex''' || texture || 0.2 0.2 0.2 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodtex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodbias''' || float || 0.0 || With bias = -1, only the bricktex is used for the brick color. With bias between -1 and 1, a pseudo-random interpolation between bricktex and brickmodtex is used as brick color. With bias = 1, only the brickmodtex is used for the brick color.
|-
|'''scene.textures.<texture name>.brickbond''' || string || "running" || "flemish", "english", "herringbone", "basket" or "chain link"
|-
|'''scene.textures.<texture name>.brickwidth''' || float || 0.3 || brick width
|-
|'''scene.textures.<texture name>.brickheight''' || float || 0.1 || brick height
|-
|'''scene.textures.<texture name>.brickdepth''' || float || 0.15 || brick depth
|-
|'''scene.textures.<texture name>.mortarsize''' || float || 0.01 ||mortar size
|-
|'''scene.textures.<texture name>.brickrun''' || float || 0.75 || brick run
|}

This texture supports 3D mapping.

===Type: checkerboard3d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard3d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 3D mapping.

===Type: checkerboard2d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard2d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: constfloat1===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat1" || type of texture
|-
|'''scene.textures.<texture name>.value''' || float || 1.0 || constant value
|}

===Type: constfloat3===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat3" || type of texture
|-
|'''scene.textures.<texture name>.value''' || spectrum || (1.0, 1.0, 1.0) || RGB constant value
|}

===Type: densitygrid===

You can use ".data", ".data3" or ".openvdb.file" to define the 3D grid values.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "densitygrid" || type of texture
|-
|'''scene.textures.<texture name>.nx''' || unsigned int || || grid x size
|-
|'''scene.textures.<texture name>.ny''' || unsigned int || || grid y size
|-
|'''scene.textures.<texture name>.nz''' || unsigned int || || grid z size
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.storage''' || string || "half" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.data''' || float || || vector grid values (total count: nx * ny * nz)
|-
|'''scene.textures.<texture name>.data3''' || float || || vector grid values (total count: nx * ny * nz * 3)
|-
|'''scene.textures.<texture name>.openvdb.file''' || string || || OpenVDB file name
|-
|'''scene.textures.<texture name>.openvdb.grid''' || string || || OpenVDB grid name to read from the file
|}

===Type: dots===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dots" || type of texture
|-
|'''scene.textures.<texture name>.inside''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.outside''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: fbm===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fbm" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: fresnelapproxk===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxk" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: fresnelapproxn===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxn" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: hitpointalpha===

Use the value obtained by interpolating triangle vertices alphas.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointalpha" || type of texture
|}

===Type: hitpointcolor===

Use the color obtained by interpolating triangle vertices colors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointcolor" || type of texture
|}

===Type: hitpointgrey===

Use the value obtained by interpolating triangle vertices colors, mapped to a float value (RGB converted into greyscale).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointgrey" || type of texture
|-
|'''scene.textures.<texture name>.channel''' || int || -1 || the index of the RGB channel to use. -1 means the luminance of the RGB value
|}

===Type: hsv===

Hue saturation value manipulation.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hsv" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input color that will be manipulated
|-
|'''scene.textures.<texture name>.hue''' || texture || 0.5 || shift in hue (range: 0..1)
|-
|'''scene.textures.<texture name>.saturation''' || texture || 1.0 || saturation (range: 0..inf)
|-
|'''scene.textures.<texture name>.value''' || texture || 1.0 || brightness multiplier (range: 0..inf)
|}

===Type: imagemap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "imagemap" || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || "image.png" || name of the image file
|-
|'''scene.textures.<texture name>.gamma''' || float || 2.2 || gamma correction value used in the image
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 || image values are multiplied by gain value
|-
|'''scene.textures.<texture name>.storage''' || string || "auto" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of image map wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.channel''' || string || "default" || extract from the image only the selected channels: "default", "red", "green", "blue", "alpha", "mean", "colored_mean", "rgb"
|}

===Type: normalmap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "normalmap" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input. Is treated as an XYZ vector in tangent space.
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || multiplier for adjusting normalmap height
|}

===Type: marble===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "marble" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || marble scale
|-
|'''scene.textures.<texture name>.variation''' || float || 0.2 || marble variation
|}

This texture supports 3D mapping.

===Type: mix===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "mix" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.texture1''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: scale===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "scale" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: uv===

This procedural texture has no parameters aside from the support of 2D mapping.

===Type: windy===

This procedural texture has no parameters aside from the support of 3D mapping.

===Type: wood===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || "bands", "rings", "bandnoise" or "ringnoise"
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || "sin", "saw" or "tri"
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || "soft_noise" or "hard_noise"
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 || noise size
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 || noise turbulence
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 || bright
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 || contrast
|}

This texture supports 3D mapping.

===Type: wrinkled===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wrinkled" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: abs===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "abs" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|}

===Type: clamp===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "clamp" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.min''' || float || 0.0 || lower boundary of the clamping
|-
|'''scene.textures.<texture name>.max''' || float || 1.0 || upper boundary of the clamping
|}

===Type: divide===

Note: If texture2 (the divisor) is 0, 0 is returned.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "divide" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant (dividend)
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant (divisor)
|}

===Type: remap===

This texture brings the value from the source range into the target range.

Note: The value is clamped into source range before performing the remap operation, and the resulting number is also clamped into the target range.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "remap" || type of texture
|-
|'''scene.textures.<texture name>.value''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemax''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmax''' || texture || 1.0 || texture name or constant
|}

===Type: objectid===

Raw object ID (range 0 to 0xfffffffe).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectid" || type of texture
|}

===Type: objectidcolor===

Object ID interpreted as color. 
The object ID is a 4 byte unsigned int. To convert to color, the lower three bytes are interpreted as r, g, b values (each range 0 to 255). The highest byte is ignored.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidcolor" || type of texture
|}

===Type: objectidnormalized===

Normalized object ID (range 0 to 1).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidnormalized" || type of texture
|}

===Type: dotproduct ===

Dot product of the two input vectors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dotproduct" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: power ===

pow(base, exponent)

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "power" || type of texture
|-
|'''scene.textures.<texture name>.base''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.exponent''' || texture || 1.0 || texture name or constant
|}

===Type: lessthan ===

returns 1 if texture1 < texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lessthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: greaterthan ===

returns 1 if texture1 > texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "greaterthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: shadingnormal ===

Returns the shading normal of the mesh at the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "shadingnormal" || type of texture
|}

===Type: position ===

Returns the position of the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "position" || type of texture
|}

===Type: splitfloat3 ===

Extract a channel from a float3 texture. Can for example be used to get the R, G or B channel of a color texture, or to get the X, Y or Z components of a vector texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "splitfloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.channel''' || int || 0 || the channel to get from the input texture. 0 for first channel, 1 for second, 2 for third channel
|}

===Type: makefloat3 ===

Combine three float textures into one float3 texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "makefloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture3''' || texture || 1.0 || texture name or constant
|}

===Type: blackbody===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blackbody" || type of texture
|-
|'''scene.textures.<texture name>.temperature''' || float || 6500 || emission temperature
|-
|'''scene.textures.<texture name>.normalize''' || bool || false || normalize the output
|}

===Type: irregulardata===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "irregulardata" || type of texture
|-
|'''scene.textures.<texture name>.wavelengths''' || vector || 580.0 620.0 660.0|| wavelenghts
|-
|'''scene.textures.<texture name>.data''' || vector || 0.0 0.000015 0.0|| data (length should match wavelength's length)
|}

===Type: lampspectrum===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lampspectrum" || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || "Daylight" || lamp light spectrum
|}

===Type: Fresnel Textures===

Textures for loading optical data

====Type: fresnelcolor====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelcolor || type of texture
|-
|'''scene.textures.<texture name>.kr''' || vector || 0.5 0.0 0.0 || reflection color
|}

====Type: fresnelpreset====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || aluminium || fresnel preset ("aluminium", "silver", "copper", "gold" or "amorphous carbon")
|}

====Type: fresnelsopra====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Au.nk)
|}

====Type: fresnelluxpop====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Cr.nk)
|}

====Type: distort====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || distort || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0.0 || texture name or constant; input texture
|-
|'''scene.textures.<texture name>.offset''' || texture || 0.0 || texture name or constant; offset to add to the hitpoint coordinates and UV values before evaluating the input texture
|-
|'''scene.textures.<texture name>.strength''' || float || 1.0 || strength multiplier, is multiplied with the offset
|}

==Volumes==

Check [[LuxCoreRender_Volumes|LuxCoreRender Volumes]] for a high level description and examples of the volumes.

All volumes share these properties

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|-
|'''scene.volumes.<volume name>.priority''' || unsigned int|| 0|| volume priority (when volumes overlap, the one with highest priority overrides the others)
|-
|'''scene.volumes.<volume name>.ior''' || texture|| ... || index of refraction
|-
|'''scene.volumes.<volume name>.absorption''' || texture || ... || absorption texture
|-
|'''scene.volumes.<volume name>.emission ''' || texture || ... || emission
|-
|'''scene.volumes.<volume name>.emission.id ''' || unsigned int || ... || emission ID
|}

===Volume: Clear===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|}

===Volume: Homogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || homogeneous|| volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|}

===Volume: Heterogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || heterogeneous || volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|-
|'''scene.volumes.<volume name>.steps.size''' || float || ... || step size
|-
|'''scene.volumes.<volume name>.steps.maxcount''' || unsigned int || ... || step maximum count
|}

==Materials==

Check [[LuxCoreRender_Materials|LuxCoreRender Materials]] for a high level description and examples of the materials.

===Common properties===

Common material properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.bumptex''' || texture || || texture to use for the bump mapping
|-
|'''scene.materials.<material name>.normaltex''' || texture || || texture to use for the normal mapping
|-
|'''scene.materials.<material name>.samples''' || int || -1 || number of rays used to sample this material. -1 means use the default global value. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.diffuse.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.glossy.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.specular.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.bumpsamplingdistance''' || float || 0.001 || set the offset used to sample bump/normal mapping.
|-
|'''scene.materials.<material name>.volume.interior''' || string || vol1 || name of interior volume (for volume rendering)
|-
|'''scene.materials.<material name>.volume.exterior''' || string || vol2 || name of exterior volume (for volume rendering)
|-
|'''scene.materials.<material name>.id''' || int|| ... || material id
|-
|'''scene.materials.<material name>.transparency''' || texture || 1.0 || transparency of the material. 1 for opaque, 0 for fully transparent
|-
|'''scene.materials.<material name>.shadowcatcher.enable''' || bool || false || If true, the material will be transparent where hit by direct light and opaque otherwise (alpha transparency). Used for compositing.
|}

====Normal maps====
Normal maps are set first as a texture type and then assigned to the material. For example:

<blockquote><pre>
scene.textures.normmap.type = imagemap
scene.textures.normmap.file = scenes/bump/normal.png
scene.textures.normmap.gamma = 1

scene.materials.mat_white.type = matte
scene.materials.mat_white.kd = 0.8 0.8 0.8
scene.materials.mat_white.normaltex = normmap
</pre></blockquote>

====Light emission====

All materials can emit light:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.emission''' || texture || 0.0 0.0 0.0 || color of the emitted light
|-
|'''scene.materials.<material name>.emission.gain''' || spectrum || 1.0 1.0 1.0 || multiplier for lamp brigthness
|-
|'''scene.materials.<material name>.emission.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.materials.<material name>.emission.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.materials.<material name>.emission.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light
|-
|'''scene.materials.<material name>.emission.iesblob''' || blob || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.materials.<material name>.emission.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.materials.<material name>.emission.samples''' || int || -1 || the number of shadow ray to trace to compute direct light from this material. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.materials.<material name>.emission.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.
|-
|'''scene.materials.<material name>.emission.theta''' || float || 90.0 || How directional the light is emitted, set as the half-angle of the light source. Default is 90°. Smaller values mean that more light is emitted in the direction of the face normals and less to the sides.
|-
|'''scene.materials.<material name>.emission.importance''' || float || 1.0 || A hint how often to sample this light source compared to other lights
|}

===Type: archglass===

This material should be used to replace glass material of windows when rendering architectural interiors. It allows direct light to pass trough.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "archglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: carpaint===

Car Paint is an advanced glossy material, simulating a diffuse surface with mutliple reflective coatings.

The available presets for the carpaint material are:

*"ford f8"
*"polaris silber"
*"opel titan"
*"bmw339"
*"2k acrylack"
*"white"
*"blue"
*"blue matte"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "carpaint" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "ford f8" || one of the avilable presets
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || absorption color
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || absorption depth
|-
|'''scene.materials.<material name>.kd''' || texture || 0.0 0.0 0.0 || diffuse color
|-
|'''scene.materials.<material name>.ks1''' || texture || 0.0 0.0 0.0 || specular color - layer 1
|-
|'''scene.materials.<material name>.ks2''' || texture || 0.0 0.0 0.0 || specular color - layer 2
|-
|'''scene.materials.<material name>.ks3''' || texture || 0.0 0.0 0.0 || specular color - layer 3
|-
|'''scene.materials.<material name>.r1''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 1
|-
|'''scene.materials.<material name>.r2''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 2
|-
|'''scene.materials.<material name>.r3''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 3
|-
|'''scene.materials.<material name>.m1''' || texture || 0.0 0.0 0.0 || roughness - layer 1
|-
|'''scene.materials.<material name>.m2''' || texture || 0.0 0.0 0.0 || roughness - layer 2
|-
|'''scene.materials.<material name>.m3''' || texture || 0.0 0.0 0.0 || roughness - layer 3
|}

===Type: cloth===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "cloth" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "denim" || denim, silk_charmeuse, silk_shantung, cotton_twill, wool_garbardine or polyester_lining_cloth
|-
|'''scene.materials.<material name>.weft_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in one weave direction
|-
|'''scene.materials.<material name>.weft_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in one weave direction
|-
|'''scene.materials.<material name>.warp_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.warp_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.repeat_u''' || float || 100.0 || thread count in the u direction
|-
|'''scene.materials.<material name>.repeat_v''' || float || 100.0 || thread count in the v direction
|}

===Type: disney===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "disney" || type of material
|-
|'''scene.materials.<material name>.basecolor''' || texture || 0.5 0.5 0.5 || Base color
|-
|'''scene.materials.<material name>.subsurface''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.roughness''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.metallic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.specular''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.speculartint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoat''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoatgloss''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.anisotropic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheen''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheentint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.filmamount''' || texture || none || Linear interpolation between no film (0) and full film effect (1) for artistic control. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.cauchyb''' || texture || 0.0 || if defined and > 0.0, enable dispersion. The value is the B term of the [https://en.wikipedia.org/wiki/Cauchy%27s_equation Cauchy's equation]
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glossy2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossy2" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossytranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossytranslucent" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmission color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.ks_bf''' || texture || 0.5 0.5 0.5 || texture or constant backface specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.uroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.vroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.ka_bf''' || texture || 0.0 0.0 0.0 || texture or constant value of backface coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.d_bf''' || texture || 0.0 || texture or constant value of the backface depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.index_bf''' || texture || 0.0 0.0 0.0 || IOR of the backface coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|-
|'''scene.materials.<material name>.multibounce_bf''' || bool || false || backface simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossycoating===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossycoating" || type of material
|-
|'''scene.materials.<material name>.base''' || string || || name of base material, the coating layer is added on top of this material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: matte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "matte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the matte material
|}

===Type: mattetranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mattetranslucent" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 0.5 0.5 0.5 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmitted color of the material
|}

===Type: metal2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "metal2" || type of material
|-
|'''scene.materials.<material name>.fresnel''' || fresnel texture || ... || [[#Type:_Fresnel_Textures | fresnel texture]]
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.preset''' || string || "aluminium" || (DEPRECATED) "aluminium", "silver", "copper", "gold" or "amorphous carbon"
|-
|'''scene.materials.<material name>.n''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxn texture on overwrite the .preset property
|-
|'''scene.materials.<material name>.k''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxk texture on overwrite the .preset property
|}

===Type: mirror===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mirror" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|}

===Type: mix===

This material can be used to mix 2 other materials.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mix" || type of material
|-
|'''scene.materials.<material name>.material1''' || string || mat1 || name of another material
|-
|'''scene.materials.<material name>.material2''' || string || mat2 || name of another material
|-
|'''scene.materials.<material name>.amount''' || texture || 0.5 || texture or constant value used to mix the materials
|}

===Type: null===

This is empty, not visible material. It can be combined by using mix material with others. It is often used in combination with the alpha channel of an image map to render leafs, etc.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "null" || type of material
|}

===Type: roughglass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: roughmatte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughmatte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the roughmatte material
|-
|'''scene.materials.<material name>.sigma''' || texture || 0.0 || the sigma parameter in the Oren-Nayer shader in degrees. Zero for pure Lambertian reflection
|}

===Type: velvet===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "velvet" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || color of the material's fuzz
|-
|'''scene.materials.<material name>.p1''' || texture || -2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p2''' || texture || 20.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p3''' || texture || 2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.thickness''' || texture || 0.1 || height of the fuzz
|}

==Objects==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.material''' || string || || type of object material
|-
|'''scene.objects.<object name>.shape''' || string || || name of [[#Shapes | shape]] with the triangle mesh description.Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same shape, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.ply''' || string || || '''(Deprecated, use .shape instead)''' name of [http://en.wikipedia.org/wiki/PLY_(file_format) PLY] file with the triangle mesh description. Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same file, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.objects.<object name>.vertices''' || float || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of float values defining the vertices of the mesh (i.e. 3 coordinates for each vertex).
|-
|'''scene.objects.<object name>.faces''' || unsigned int || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of unsigned int values defining the triangles of the mesh (i.e. 3 index of vertices for each triangle).
|-
|'''scene.objects.<object name>.id''' || unsigned int || || object ID
|-
|'''scene.objects.<object name>.camerainvisible''' || bool || false || toggle visibility for camera rays. If set to true, the object will not show up in camera rays, but it will still be visible in reflections, refractions, shadows, indirect light etc.
|}

===Object Motion Blur===

LuxCore supports transformation motion blur for objects.
Motion blur is enabled if an object has a motion system defined as described below.

A motion system consists of steps (at least 2). Each step has a time (in seconds) and a transformation matrix of the object at this point in time.
Step indices start at 0. The times have to be monotonic (each greater than the last).

Note that the embree accelerator only supports a maximum of 129 time steps.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.motion.<step>.time''' || float || || time (in seconds) of the step
|-
|'''scene.objects.<object name>.motion.<step>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix of the object at the given step
|-
|}

==Shapes==

===Type: mesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "mesh" || mesh shape
|-
|'''scene.shapes.<shape name>.ply''' || string || ... || mesh path (e.g ''scenes/luxball/luxball-shell.ply'')
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: inlinedmesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "inlinedmesh" || inlinedmesh shape
|-
|'''scene.shapes.<shape name>.vertices''' || vector || ... || inlinedmesh vertices (e.g 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0 0.0)
|-
|'''scene.shapes.<shape name>.faces''' || vector || ... || inlinedmesh faces (e.g 0 1 2)
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: pointiness===

Contains surface curvature information in vertex alpha channel. 
You can access this information in materials via a hitpointalpha texture. 
The values range from -1 to 1 (float). 
Values from -1 to 0 are concave, while values from 0 to 1 are convex.

[[ Shape:_Pointiness | Examples ]]

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "pointiness" || pointiness shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || pointiness source (a mesh shape)
|}

===Type: strands===

Can be used for hair, fur, grass etc. 
Note that you need to define the camera before defining any strands shapes, because the tesselation process is viewpoint-dependent.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "strands" || strands shape
|-
|'''scene.shapes.<shape name>.file''' || string || ... || strands file (''scenes/strands/straight.hair'')
|}

====Strands tessellation methods====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbon" || ribbon tessellation
|-
|'''scene.shapes.<shape name>.tessellation.usecameraposition''' || bool || 1 || use camera position
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbonadaptive" || ribbon adaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.maxdepth''' || unsigned int || 12 || max tessellation depth
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.error ''' || float || 0.0075 || max tessellation error
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solid" || solid tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solid.sidecount ''' || unsigned int || 12 || tessellation's side count
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solidadaptive" || solidadaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.sidecount ''' || unsigned int || 8 || tessellation's side count
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.maxdepth''' || unsigned int || 16 || tessellation's max depth
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.error''' || float || 0.05 || tessellation's max error
|}

===Type: group===

Todo.

===Type: displacement===

Todo.

===Type: subdiv===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "subdiv" || subdivided shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || source mesh name
|-
|'''scene.shapes.<shape name>.maxlevel''' || unsigned integer || 2 || maximum level of subdivision
|-
|'''scene.shapes.<shape name>.maxedgescreensize''' || float || 0.0 || maximum edge screen size
|-
|'''scene.shapes.<shape name>.adaptive''' || bool || 1 || Adaptive refinement / Uniform refinement
|}

===Type: harlequin===

Todo.

===Type: simplify===

Todo.

===Type: islandaov===

Todo.

===Type: randomtriangleaov===

Todo.

==Light sources==

Check [[Lighting|LuxCoreRender Lighting]] for an high level description and example of the light sources.

===Common parameters===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.gain''' || spectrum || 1.0 1.0 1.0 || intensity of the light
|-
|'''scene.lights.<light name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.lights.<light name>.samples''' || int || -1 || the number of shadow ray to trace to compute direct light for this light source. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.

|-
|'''scene.lights.<light name>.importance''' || float || 1.0 || A hint how often to sample this light compared to other lights
|}

===Type: sun===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sun" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.relsize''' || float || 1.0 || relative size to the sun
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sky2===

Hosek-Wilkie sky model.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sky2" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.gain''' || vector || ... || gain
|-
|'''scene.lights.<light name>.groundalbedo''' || vector || 0.5 0.5 0.5 || ground albedo
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.ground.enable''' || bool || 1 || enable ground color
|-
|'''scene.lights.<light name>.ground.color''' || vector|| ... || RGB ground color
|}

===Type: infinite===

Spherical lightsource surrounding the scene at infinite distance. 
Used for image based lighting (IBL) and HDR environment lighting if the file is a high dynamic range image.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "infinite" || type of light
|-
|'''scene.lights.<light name>.file''' || string || "image.png" || filename of the environment map
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma correction used by the image map
|-
|'''scene.lights.<light name>.storage''' || string || "auto" || environment map storage type ("auto", "byte", "half" or "float")
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.sampleupperhemisphereonly''' || bool || false || an option set to black the lower hemisphere. Mostly useful for shadow catchers.
|}

===Type: point===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "point" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mappoint===

Point light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mappoint" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: sphere===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mapsphere===

Sphere light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mapsphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: spot===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "spot" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.coneangle''' || float || 30.0 || angle in degrees of the spotlight cone
|-
|'''scene.lights.<light name>.conedeltaangle''' || float || 5.0 || angle at which the spotlight intensity starts to fade from the edge
|}

===Type: projection===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "projection" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.fov''' || float || 45.0 || field of view in terms of angular spread along the shorter image axis
|-
|'''scene.lights.<light name>.mapfile''' || string || || filename of the image to project. If not specified, a constat light color will be used.
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|}

===Type: constantinfinite===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "constantinfinite" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sharpdistant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sharpdistant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|}

===Type: distant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "distant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|-
|'''scene.lights.<light name>.theta''' || float || 10.0 || half angle of the light source in degree. Must be > 0 for soft shadows
|}

===Type: laser===

A light source emitting parallel light rays (like sharpdistant light, but starting inside the scene instead of infinitely far away).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "laser" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.radius''' || float || 0.01 || radius of the laser beam
|}

LuxCore SDL Reference Manual v2.11

2026-06-07T10:19:57Z

CodeHD: /* Camera */ reformat table

The scene description language (SDL) is used to configure the renderer and to define objects, materials, textures etc. in the scene. 
The file ending of the render configuration file is ".cfg", for the scene file it's ".scn".

These files are usually created by exporter plugins, e.g. BlendLuxCore. 
This wiki page is primarily a reference for exporter developers, normal end-users should not need to edit cfg/scn files by hand.

Sometimes the API is updated faster than the wiki, in this case you can look at the code directly: https://github.com/LuxCoreRender/LuxCore/tree/master/src/slg/scene

Note that matrices are passed as flat lists in column-major form.

=Render configuration file=

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''resumerendering.filesafe''' || bool || 1 || enable/disable "safe save" mode for resume rendering file. A backup of the output is always valid even in the case of a system failure
|}

==Seed==

The global seed value that is used to generate random numbers. 
Two images rendered with the same seed will have the same noise pattern.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.seed''' || unsigned int || 1 || min 1
|}

==Periodic save==

Options related to periodic save operations.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''periodicsave.resumerendering.period''' || float || 0 || save the resume rendering file every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.resumerendering.filename''' || string || "resume.rsm" || the name to use to save the rendering resume information periodically
|-
|'''periodicsave.film.period''' || float || 0 || save the Film every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.film.filename''' || string || "film.flm" || the name to use to save the film periodically
|-
|'''periodicsave.film.outputs.period''' || float || 600 || save all Film outputs every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|}

==Render Engine==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.type''' || string || "PATHCPU" || engine type
|}

=== CPU Render Engines ===

CPU render engines are written in C++ and don't require OpenCL. All CPU render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''native.threads.count''' || int || CPU core count || > 0 || > 0 || The number of threads will be used for the rendering
|}

'''The following CPU engines are available:'''

===="PATHCPU"====

A path tracer with full image plane rendering (i.e. supporting Metropolis sampler).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|}

===="TILEPATHCPU"====
Biased path tracer with many control options and support for tile rendering. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|-
|'''tilepath.sampling.aa.size''' || int || 3 || > 0 || [1, 13] || All diffuse/glossy/specular samples are multiplied with the squared aa size: final_samples = aa^2 * (diffuse^2 + glossy^2 + specular^2)
|-
|'''tile.size''' || int || 32 || ≥ 8 || [8, 256] || Tile size in pixels
|-
|'''tile.multipass.enable''' || bool || 1 || 0 or 1 || o or 1 || Re-render the image until a halt threshold is met or indefinitely
|-
|'''tile.multipass.convergencetest.threshold''' || float || 6.0 / 256.0 || > 0.0 || [1.0 / 256.0, 6.0 / 256.0] || Target noise level
|-
|'''tile.multipass.convergencetest.threshold.reduction''' || float || 0.0 || [0.0, 1.0] || [0.75, 0.95] || Multiply noise level with this number when all tiles have met the previous noise level. Set to 0 to disable (so rendering will stop at the noise level)
|-
|'''tile.multipass.convergencetest.warmup.count''' || int || 32 || ≥ 0 || [8, 128] || Warm up period for the convergence test expressed in samples per pixel
|}

===="BIDIRCPU"====

A Bidirectional path tracer.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a eye path
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

===="RTPATHCPU"====
Engine optimized for interactive scene editing and camera movement. 
The sampler must be set to RTPATHCPUSAMPLER when using this engine.

Supports the same properties as [[#"PATHCPU" | "PATHCPU"]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpathcpu.zoomphase.size''' || int || 4 || || || render scaled down film for the first few frames after a scene edit (to make interactions more fluid)
|-
|'''rtpathcpu.zoomphase.weight''' || float || 0.1 || || || description: TODO
|}

=== OpenCL Render Engines ===

OpenCL engines can run on GPUs, CPUs and other types of computing devices, they require OpenCL to run. All OpenCL render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''opencl.platform.index''' || int || -1 || A valid platform index || -1 || Select the OpenCL platform to use. All devices available on all platforms will be used with -1
|-
|'''opencl.cpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL CPU devices available
|-
|'''opencl.gpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL GPU devices available
|-
|'''opencl.cpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.gpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.devices.select''' || string || "" || Any valid selection string || Any valid selection string || Select each OpenCL device to use. It is a string of "0" and "1". "1" means use the device, "0" do not
|}

'''The following OpenCL engines are available:'''

===="PATHOCL"====
OpenCL version of PATHCPU. Supports the same settings as [[#"PATHCPU" | PATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''pathocl.pixelatomics.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable pixel atomic operation
|-
|'''opencl.task.count''' || int || "AUTO" || "AUTO" or > 0 || [64K, 1024K] || The number of tasks sent to the OpenCL device in one kernel call
|}

===="RTPATHOCL"====

A PATHOCL version optimized for real-time rendering with fixed frame-rate and variable quality. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"PATHOCL" | PATHOCL]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpath.resolutionreduction.preview''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels in the first passes. For instance 4x4 than 2x2 and than always 1x1
|-
|'''rtpath.resolutionreduction.preview.step''' || int || 8 || > 0 || [1, 32] || Each preview step is rendered for n frames
|-
|'''rtpath.resolutionreduction''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels, outside the preview phase, in order to reduce the per frame rendering time
|}

===="TILEPATHOCL"====

OpenCL version of TILEPATHCPU. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"TILEPATHCPU" | TILEPATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''tilepathocl.devices.maxtiles''' || int || 16 || ≥ 1 || [1, 32] || Maximum number of tiles to send in a single call to each OpenCL device
|}

==="FILESAVER"===

Saves everything needed to render the scene to the output path, including textures and meshes.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''filesaver.format''' || string || "TXT" || "TXT" for a text SDL format and "BIN" for a single file binary format
|-
|'''filesaver.filename''' || string || "luxcore-exported-scene.bcf" || file name for "BIN" format
|-
|'''filesaver.directory''' || string || "luxcore-exported-scene" || output path for "TXT" format
|-
|'''filesaver.renderengine.type''' || string || "PATHCPU" || render engine to use when rendering the scene after it was saved with FILESAVER. Any engine string from above can be used here.
|}

===Experimental and debugging engines===

'''These engines are experimental, deprecated or are only intended for very specific purposes:'''

===="BIDIRVMCPU"====

Bidir with vertex merging, currently experimental. 
Supports the same settings as [[#"BIDIRCPU" | BIDIRCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''bidirvm.lightpath.count''' || int || 16 * 1024 || > 0 || || Number of lightpaths per pass
|-
|'''bidirvm.startradius.scale''' || float || 0.003 || > 0 || || Photon radius of the first pass
|-
|'''bidirvm.alpha''' || float || 3 || > 0 || [0.0, 1.0] || Photon radius is multiplied with this value after every pass to reduce the radius
|}

===="LIGHTCPU"====

For testing.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''light.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''light.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

==Sampler==

Samplers are used by following render engines:

* LIGHTCPU
* PATHCPU
* BIDIRCPU
* BIDIRVMCPU
* PATHOCL

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''sampler.type''' || string || "SOBOL" || sampler type
|}

The following samplers are available:

==="SOBOL"===

Sampler with sobol pattern.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.sobol.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==="METROPOLIS"===

Metropolis sampler.
Parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.metropolis.largesteprate''' || float || 0.4 || 0 ≤ x ≤ 1 || 0 - 1 || Probability of generating a large sample mutation
|-
|'''sampler.metropolis.maxconsecutivereject''' || int || 512 || x ≥ 0 || 0 - 32768 || Number of consecutive rejects before a next mutation is forced. Low values can cause bias
|-
|'''sampler.metropolis.imagemutationrate''' || float || 0.1 || 0 ≤ x ≤ 1 || 0 - 1 || Maximum distance over the image plane for a small mutation
|}

==="RANDOM"===

Fully random sampler. This sampler is mostly intended for testing purpose.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.random.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==Filter==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.type''' || string || "BLACKMANHARRIS" || || || Type of pixel filter.
|-
|'''film.filter.width''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Filter radius in pixels. Does not have an effect on the NONE filter
|-
|'''film.filter.xwidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|-
|'''film.filter.ywidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|}

Available filters are:

==="NONE"===

Disable pixel filtering.

==="BOX"===

Box pixel filter. No parameters.

==="GAUSSIAN"===

Gaussian pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.gaussian.alpha''' || float || 2.0 || x > 0.0 || 0.1 - 10.0 || Gaussian rate of falloff. Lower values give blurrier images.
|}

==="MITCHELL"===

Mitchel pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchell.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchell.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="MITCHELL_SS"===

Mitchel pixel filter with super-sampling (i.e. image will be filtered first with a grid of 4 pixels for each pixel).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchellss.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchellss.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="BLACKMANHARRIS"===

Blcakman-Harris pixel filter. No parameters.

==Light Strategy==

The direct light sampling strategy is defined by the following property:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.type''' || string || "LOG_POWER" || "UNIFORM", "POWER", "LOG_POWER" or "DLS_CACHE" || N/A || Direct light sampling strategy
|}

==="UNIFORM"===

"UNIFORM" light strategy samples evenly all light sources.

==="POWER"===

"POWER" light strategy samples the light sources based on their power.

==="LOG_POWER"===

"LOG_POWER" light strategy samples the light sources based on logarithm of their power.

==="DLS_CACHE"===

Build direct light sampling cache to optimize many-lights rendering, beneficial in scenes with multiple light sources with few overlap between their influence areas (e.g. a building with many disconnected rooms and interior lights).

Options for the DLS cache:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.entry.radius''' || float || 0.0 || || N/A || Entry radius in meters, automatic radius estimation is used if the radius is set to 0
|-
|'''lightstrategy.entry.normalangle''' || float || 25.0 || || N/A ||
|-
|'''lightstrategy.entry.maxpasses''' || int || 1024 || || N/A ||
|-
|'''lightstrategy.entry.convergencethreshold''' || float || 0.05 || || N/A ||
|-
|'''lightstrategy.entry.warmupsamples''' || int || 24 || || N/A ||
|-
|'''lightstrategy.targetcachehitratio''' || float || 0.995 || || N/A ||
|-
|'''lightstrategy.maxdepth''' || int || 4 || || N/A ||
|-
|'''lightstrategy.maxsamplescount''' || int || 10000000 || || N/A ||
|-
|'''lightstrategy.persistent.file''' || string || "" || || N/A ||
|-
|'''lightstrategy.persistent.safesave''' || bool || 1 || || N/A ||

|}

==Accelerator==

The ray/triangle intersection accelerator to use for the rendering is defined by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''accelerator.type''' || string || "AUTO" || "AUTO", "BVH", "MBVH", "EMBREE" || "AUTO" || The intersection accelerator. "AUTO" will select the best one available for the current [[LuxRays]] intersection device. "EMBREE" is currently usable only on CPU render engines
|-
|'''accelerator.instances.enable''' || bool || 1 || 0 or 1 || 0 or 1 || Enable instance support (or disable in order to slightly increase rendering speed)
|}

==Epsilon==

Minimum and maximum allowed value for scene epsilon can be define by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''scene.epsilon.min''' || float || 1e-5f || Any float value || 1e-6f ≤ x ≤ 1e-1f || Minimum allowed value for scene epsilon
|-
|'''scene.epsilon.max''' || float || 1e-1f || Any float value || 1e-3f ≤ x ≤ 1e+2f || Maximum allowed value for scene epsilon
|}

==Film==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.safesave''' || bool || 1 || enable "safe save" of Film serialization. A backup of the output is always valid even in the case of a system failure.
|}

===Film OpenCL Options===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.opencl.enable''' || bool || 1 || enable OpenCL film operations
|-
|'''film.opencl.platform''' || unsigned int || -1 || choose which platform will be used by the film operations. (0 is first platform, 1 second and so on. -1 for all)
|-
|'''film.opencl.device''' || unsigned int || -1 || choose which device will be used by the film operations. (0 is first device, 1 second and so on. -1 for first GPU device)
|}

===Film Outputs (aka AOVs)===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.safesave''' || bool || 1 || enable "safe save" for Film outputs. A backup of the output is always valid even in the case of a system failure
|}

The film object supports many types of outputs (aka AOVs). The complete list of supported output types:

{| class="wikitable" cellspacing="2"
!Name
!Type
|-
|'''RGB''' || HDR
|-
|'''RGBA''' || HDR
|-
|'''RGB_IMAGEPIPELINE''' || HDR/LDR
|-
|'''RGBA_IMAGEPIPELINE''' || HDR/LDR
|-
|'''ALPHA''' || HDR/LDR
|-
|'''DEPTH''' || HDR
|-
|'''POSITION''' || HDR
|-
|'''GEOMETRY_NORMAL''' || HDR
|-
|'''SHADING_NORMAL''' || HDR
|-
|'''MATERIAL_ID''' || LDR
|-
|'''DIRECT_DIFFUSE''' || HDR
|-
|'''DIRECT_GLOSSY''' || HDR
|-
|'''EMISSION''' || HDR
|-
|'''INDIRECT_DIFFUSE''' || HDR
|-
|'''INDIRECT_GLOSSY''' || HDR
|-
|'''INDIRECT_SPECULAR''' || HDR
|-
|'''MATERIAL_ID_MASK''' || HDR/LDR
|-
|'''DIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''INDIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''RADIANCE_GROUP''' || HDR/LDR
|-
|'''UV''' || HDR/LDR
|-
|'''RAYCOUNT''' || HDR/LDR
|-
|'''BY_MATERIAL_ID''' || HDR/LDR
|-
|'''IRRADIANCE''' || HDR
|-
|'''OBJECT_ID''' || LDR
|-
|'''OBJECT_ID_MASK''' || HDR/LDR
|-
|'''BY_OBJECT_ID''' || HDR/LDR
|-
|'''SAMPLECOUNT''' || HDR/LDR
|-
|'''CONVERGENCE''' || HDR/LDR
|-
|'''NOISE''' || HDR/LDR
|-
|'''SERIALIZED_FILM''' || N/A
|-
|'''MATERIAL_ID_COLOR''' || HDR/LDR
|}

Outputs are enabled with the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.<index>.type''' || string || || Type of output, e.g. "RGBA" or "ALPHA" (see the list above for the available types)
|-
|'''film.outputs.<index>.filename''' || string || || Filename to use when saving the output. The filename should use ".exr" as extension for HDR outputs and ".png" for LDR outputs (see list above for which output is HDR and which LDR)
|-
|'''film.outputs.<index>.id''' || int || || Specify for the following outputs: '''MATERIAL_ID_MASK''', '''RADIANCE_GROUP''', '''BY_MATERIAL_ID''', '''OBJECT_ID_MASK''', '''BY_OBJECT_ID''' (to choose the object ID, material ID or radiance group ID of the output)
|-
|'''film.outputs.<index>.index''' || int || || Specify for an imagepipeline output (RGB_IMAGEPIPELINE or RGBA_IMAGEPIPELINE) to select the imagepipeline of the output. For example, if you have 3 imagepipelines defined, and you want to specify the output of the third imagepipeline, use 2 for the ".index" property of the output
|}

Note that the Bidir engine does not support all AOVs.
Not supported by Bidir are: EMISSION, DIRECT_DIFFUSE, DIRECT_GLOSSY, INDIRECT_DIFFUSE, INDIRECT_GLOSSY, INDIRECT_SPECULAR, DIRECT_SHADOW_MASK, INDIRECT_SHADOW_MASK, IRRADIANCE, RAYCOUNT.

This is the list of output channel data types and sizes:

{| class="wikitable" cellspacing="2"
!Output type
!Data type
!Size
!Description
|-
|RGB||float||film width x film height x 3||R, G, B
|-
|RGB_IMAGEPIPELINE||float||film width x film height x 3||R, G, B
|-
|RGBA||float||film width x film height x 4||R, G, B, A
|-
|ALPHA||float||film width x film height x 1||Alpha value [0, 1]
|-
|DEPTH||float||film width x film height x 1||Camera distance
|-
|POSITION||float||film width x film height x 3||World X, Y, Z
|-
|GEOMETRY_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|SHADING_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|DIRECT_DIFFUSE||float||film width x film height x 3||Diffuse R, G, B
|-
|DIRECT_GLOSSY||float||film width x film height x 3||Glossy R, G, B
|-
|EMISSION||float||film width x film height x 3||Emission R, G, B
|-
|INDIRECT_DIFFUSE||float||film width x film height x 3||Indirect diffuse R, G, B
|-
|INDIRECT_GLOSSY||float||film width x film height x 3||Indirect glossy R, G, B
|-
|INDIRECT_SPECULAR||float||film width x film height x 3||Indirect specular R, G, B
|-
|MATERIAL_ID_MASK||float||film width x film height x 1||Material mask [0, 1]
|-
|DIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|INDIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|RADIANCE_GROUP||float||film width x film height x 3||R, G, B
|-
|UV||float||film width x film height x 2||Texture coordinates U, V
|-
|RAYCOUNT||float||film width x film height x 1||Ray count
|-
|BY_MATERIAL_ID||float||film width x film height x 3||By material ID
|-
|MATERIAL_ID||uint||film width x film height x 1||Material ID
|-
|IRRADIANCE||float||film width x film height x 3||R, G, B
|-
|OBJECT_ID_MASK||float||film width x film height x 1||Object mask [0, 1]
|-
|BY_OBJECT_ID||float||film width x film height x 3||By object ID
|-
|OBJECT_ID||uint||film width x film height x 1||Object ID
|-
|SAMPLECOUNT||uint||film width x film height x 1||Sample count
|-
|CONVERGENCE||float||film width x film height x 1||The distance of each pixel from the convergence threshold
|-
|NOISE||float||film width x film height x 1||The noise estimated for each pixel
|-
|SERIALIZED_FILM||N/A||N/A||The complete Film serialized in binary format
|-
|MATERIAL_ID_COLOR||float||film width x film height x 3||Material ID converted to colors (with anti-aliasing)
|}

===Film Channels===

Film channels are implicitly enabled by declaring film outputs (even if the output is never used). For instance, declaring a "RGBA" output will automatically enable "RADIANCE_PER_PIXEL_NORMALIZED" (and "RADIANCE_PER_SCREEN_NORMALIZED" for BIDIRCPU) and "ALPHA".
The supported channels are:

{| class="wikitable" cellspacing="2"
!Channel type
!Data type
!Size
!Last element is weight ?
!Note
|-
|CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED||float||film width x film height x 4||Yes||One for each radiance group. Eye paths radiance.
|-
|CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED||float||film width x film height x 3||No||One for each radiance group. Light paths radiance. Used only by LIGHTCPU and BIDIRCPU.
|-
|CHANNEL_ALPHA||float||film width x film height x 2||Yes||
|-
|CHANNEL_RGB_IMAGEPIPELINE||float||film width x film height x 3||No||
|-
|CHANNEL_DEPTH||float||film width x film height x 1||No||
|-
|CHANNEL_POSITION||float||film width x film height x 3||No||
|-
|CHANNEL_GEOMETRY_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_SHADING_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_MATERIAL_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_DIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_DIRECT_GLOSSY||float||film width x film height x 4||Yes||
|-
|CHANNEL_EMISSION||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_SPECULAR||float||film width x film height x 4||Yes||
|-
|CHANNEL_MATERIAL_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_DIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_INDIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_UV||float||film width x film height x 2||No||
|-
|CHANNEL_RAYCOUNT||float||film width x film height||No||
|-
|CHANNEL_BY_MATERIAL_ID||float||film width x film height x 4||Yes||
|-
|CHANNEL_IRRADIANCE||float||film width x film height x 4||Yes||
|-
|CHANNEL_OBJECT_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_OBJECT_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_BY_OBJECT_ID||float||film width x film height x 4||Yes||
|}

This is the list of channels enabled by each output:

{| class="wikitable" cellspacing="2"
!Output
!Enabled channels
|-
|'''RGB''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''RGB_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''ALPHA''' || ALPHA
|-
|'''DEPTH''' || DEPTH
|-
|'''POSITION''' || DEPTH, POSITION
|-
|'''GEOMETRY_NORMAL''' || DEPTH, GEOMETRY_NORMAL
|-
|'''SHADING_NORMAL''' || DEPTH, SHADING_NORMAL
|-
|'''MATERIAL_ID''' || DEPTH, MATERIAL_ID
|-
|'''DIRECT_DIFFUSE''' || DIRECT_DIFFUSE
|-
|'''DIRECT_GLOSSY''' || DIRECT_GLOSSY
|-
|'''EMISSION''' || EMISSION
|-
|'''INDIRECT_DIFFUSE''' || INDIRECT_DIFFUSE
|-
|'''INDIRECT_GLOSSY''' || INDIRECT_GLOSSY
|-
|'''INDIRECT_SPECULAR''' || INDIRECT_SPECULAR
|-
|'''MATERIAL_ID_MASK''' || MATERIAL_ID, MATERIAL_ID_MASK
|-
|'''DIRECT_SHADOW_MASK''' || DIRECT_SHADOW_MASK
|-
|'''INDIRECT_SHADOW_MASK''' || INDIRECT_SHADOW_MASK
|-
|'''RADIANCE_GROUP''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''UV''' || DEPTH, UV
|-
|'''RAYCOUNT''' || DEPTH, RAYCOUNT
|-
|'''BY_MATERIAL_ID''' || BY_MATERIAL_ID
|-
|'''IRRADIANCE''' || IRRADIANCE
|-
|'''OBJECT_ID''' || DEPTH, OBJECT_ID
|-
|'''OBJECT_ID_MASK''' || OBJECT_ID, OBJECT_ID_MASK
|-
|'''BY_OBJECT_ID''' || BY_OBJECT_ID
|}

Note: CHANNEL_RGB_IMAGEPIPELINE is always enable and the result of running the image pipeline.

===Image pipeline===

It is possible to define multiple image pipelines at the same time by using the '''film.imagepipelines.<pipeline #>.''' properties prefix. Each image pipeline takes as input the raw rendering and is a chain off image pipeline plugins. Each plugin receives previous plugin output and produces a new output.

====Radiance Group====

Radiance groups are used to get only the contribution of a group of lights in the scene. 
Lights can be grouped by setting their [[#Common_parameters | '''.id''']] property to the same number, on materials this is done with the [[#Light_emission | '''.emission.id''']] property. 

Note that the OpenCL engines only support up to 8 radiance groups (one of them is the default group).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.globalscale''' || float|| 1 || global weighting of radiance group
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.temperature ''' || float || 6500.0 || light temperature
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.rgbscale''' || vector || 1.0 1.0 1.0 || light color
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.radiancescales.<id>.enabled''' || bool || 1 || enable radiance group
|}

====Image pipeline plug-ins====

=====Type: TONEMAP_LINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || linear tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 1.0 || tonemapping scale
|}

=====Type: TONEMAP_REINHARD02=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_REINHARD02" || reinhard tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.prescale''' || float || 1.0 || reinhard prescale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.postscale''' || float || 1.2 || reinhard postscale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.burn''' || float || 3.75 || reinhard burn
|}

=====Type: TONEMAP_AUTOLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_AUTOLINEAR" || automatic linear tonemapping
|}

=====Type: TONEMAP_LUXLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LUXLINEAR" || linear tonemapping with real camera settings
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sensitivity''' || float || 100.0 || ISO sensitivity
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.exposure''' || float || 0.001 || exposure time
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.fstop''' || float || 2.8 || f/aperture
|}

=====Type: NOP=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipeline.<pipeline #>.<plugin #>.type''' || string || "NOP" || no parameters tonemapper
|}

=====Type: GAMMA_CORRECTION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || gamma correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.value''' || float || 2.2 || gamma value
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.table.size''' || unsigned int || 4096 || resolution
|}

=====Type: OUTPUT_SWITCHER=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OUTPUT_SWITCHER" || overwrite output
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.channel''' || string || "DEPTH" || channel whose values are used to overwrite
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.index''' || unsigned int || 0 || index
|}

=====Type: GAUSSIANFILTER_3x3=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "GAUSSIANFILTER_3x3" || gaussian filter
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.15 || blurring weight
|}

=====Type: CAMERA_RESPONSE_FUNC=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || CAMERA_RESPONSE_FUNC || analog camera film simulation
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.name''' || string || "Advantix_100CD" || film type
|}

=====Type: BACKGROUND_IMG=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || BACKGROUND_IMG || show the background image where alpha < 1 (simple compositing)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || ... || background image path (e.g scenes/simple-mat/sky.exr)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.gamma''' || float || 2.2 || background image gamma
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.storage ''' || string || auto || background image storage type
|}
Note: When the size of the background image differs from the film size, it will be stretched to fit the film size.

=====Type: BLOOM=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "BLOOM" || bloom effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.radius''' || float || 0.07 || how large the bloom effect is in % of the image size (i.e. 1.0 = all image)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.25 || how strong the effect is (i.e. 0.0 = nothing, 1.0 = max. strength)
|}

=====Type: VIGNETTING=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "VIGNETTING" || vignetting effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 0.4 || vignetting strength
|}

=====Type: COLOR_ABERRATION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_ABERRATION" || color aberration effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || color aberration amount
|}

=====Type: MIST=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "MIST" || aerial perspective effect (fake fog)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.color''' || spectrum|| [1, 1, 1] || mist color
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || mist amount
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.startdistance''' || float || 0 || distance from camera until where the mist effect has zero effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.enddistance''' || float || 10000 || distance from camera from where the mist effect has maximum effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.excludebackground''' || bool || false || Do not apply mist effect on pixels with infinite distance to the camera
|}

=====Type: CONTOUR_LINES=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "CONTOUR_LINES" || contour lines for IRRADIANCE AOV
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.range''' || float|| ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.steps''' || int || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.zerogridsize''' || int || ? || ?
|}

=====Type: WHITE_BALANCE =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "WHITE_BALANCE" || White temperature correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.temperature''' || unsigned int|| 6500 || Target image temperature in Kelvin
|-
|}

=====Type: COLOR_LUT =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_LUT" || Applies .cube LUT (look-up-table) to the input
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || "lut.cube" || Filepath to a [https://wwwimages2.adobe.com/content/dam/acom/en/products/speedgrade/cc/pdfs/cube-lut-specification-1.0.pdf .cube LUT file]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.strength''' || float || 1.0 || Linear interpolation between input (0.0) and output (1.0) of the plugin
|-
|}

=====Type: INTEL_OIDN =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "INTEL_OIDN" || Denoises the image using [https://github.com/OpenImageDenoise/oidn Intel OIDN]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.filter.type''' || string || "RT" ||
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.oidnmemory''' || int || 6000 || Approximate maximum amount of memory to use in megabytes (actual memory usage may be higher). Limiting memory usage may cause slower denoising due to internally splitting the image into overlapping tiles
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

=====Type: OPTIX_DENOISER =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OPTIX_DENOISER" || Denoises the image using the Nvidia OptiX denoiser
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.minspp''' || unsigned int || 0 || Minimum amount of samples to be rendered before the plugin is run (at lower sample numbers, it does not modify the input)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

===Film Subregion===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.subregion''' || vector || ... || <xstart> <xstop> <ystart> <ystop>
|}

===Rendering halt conditions===

By default, a LuxCore rendering will never stop however you can enable one or multiple halt conditions:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''batch.haltnoisethreshold''' || float || -1.0 || enable image convergence test and stops when the error is under the defined value. Use a value like "n / 256.0" where n is the level of error you are looking for. It may be hard to achieve a level of error smaller than 3.0 / 256.0. -1.0 disables the halt condition.
|-
|'''batch.haltnoisethreshold.warmup''' || unsigned int || 64 || number of average samples per pixel before to start the convergence test
|-
|'''batch.haltnoisethreshold.step''' || unsigned int || 64 || number of average samples per pixel between two tests
|-
|'''batch.haltnoisethreshold.filter.enable''' || bool || 1 || if the CONVERGENCE AOV (generated by the batch.haltnoisethreshold) should be filtered or not with a 3x3 box filter
|-
|'''batch.haltnoisethreshold.stoprendering.enable''' || bool || 1 || Set this to 0 (false) if you only want to use the haltnoisethreshold settings for adaptive sampling in an endless render
|-
|'''batch.haltnoisethreshold.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for stopping
|-
|'''batch.halttime''' || float || 0.0 || number of seconds before stopping the rendering
|-
|'''batch.haltspp''' || unsigned int || 0 || number of average samples per pixel before stopping the rendering
|}

===Noise estimation===

Image noise can be estimated and its result can be used to drive the Sobol and Random samplers to focus its sampling in the noisier regions.
Setting any of these properties will enable the noise estimation.
The adaptiveness strength is a Sampler property.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.noiseestimation.warmup''' || unsigned int || 32 || number of average samples per pixel before to start the convergence test
|-
|'''film.noiseestimation.step''' || unsigned int || 32 || number of average samples per pixel between two tests
|-
|'''film.noiseestimation.filter.scale''' || unsigned int || 4 || Box filter scale used to filter the NOISE AOV (generated by the noise estimation). Set to 0 to disable.
|-
|'''film.noiseestimation.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for adaptive sampling
|-
|}

=Scene file=

==Camera==

General parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.type''' || string || "perspective" || "perspective", "orthographic", "environment" (360° panorama mapped in latlong format) or "stereo"
|-
|'''scene.camera.lookat.orig''' || point (float float float) || 0.0 10.0 0.0 || camera location
|-
|'''scene.camera.lookat.target''' || point (float float float) || 0.0 0.0 0.0 || camera target
|-
|'''scene.camera.up''' || vector (float float float) || (0.0, 0.0, 1.0) || camera up vector
|-
|'''scene.camera.fieldofview''' || float || 45.0 || field of view
|-
|'''scene.camera.shutteropen''' || float || 0.0 || camera shutter open time (used for motion blur)
|-
|'''scene.camera.shutterclose''' || float || 0.0 || camera shutter close time (used for motion blur)
|-
|'''scene.camera.autovolume.enable''' || bool || true || try automatically to discover scene.camera.volume
|-
|'''scene.camera.volume''' || string || || the initial volume rays will travel in
|-
|'''scene.camera.cliphither''' || float || 1e-3 || TBD
|-
|'''scene.camera.clipyon''' || float || 1e30 || TBD
|-
|'''scene.camera.screenwindow''' || list (float float float float) || 0.0 1.0 0.0 1.0 || <xstart> <xstop> <ystart> <ystop> (Only for "perspective"/"orthographic"/"environment")
|-
|'''scene.camera.bokeh.distribution.type''' || string || NONE || "NONE", "UNIFORM", "EXPONENTIAL", "INVERSEEXPONENTIAL", "GAUSSIAN", "INVERSEGAUSSIAN", "TRIANGULAR", "CUSTOM" (Only for "perspective")
|-
|'''scene.camera.bokeh.blades''' || int || 0 || Number of aperture blades (Only for "perspective")
|-
|'''scene.camera.bokeh.power''' || int || 3 || Distribution factor, only for "EXPONENTIAL" and "INVERSEEXPONENTIAL" types (Only for "perspective")
|-
|'''scene.camera.bokeh.distribution.image''' || string || "image.png" || only if type == "CUSTOM" (Only for "perspective")
|-
|'''scene.camera.bokeh.scalex''' || float || 1.0 || TBD (Only for "perspective")
|-
|'''scene.camera.bokeh.scaley''' || float || 1.0 || TBD (Only for "perspective")
|-
|'''scene.camera.stereo.type''' || string || "perspective" || "perspective", "environment_180", "environment_360"
|-
|'''scene.camera.eyesdistance''' || float || 0.0626 || TBD (Only for "stereo")
|-
|'''scene.camera.lensdistance''' || float || 0.2779 || TBD (Only for "stereo")
|-
|'''scene.camera.oculusrift.barrelpostpro.enable''' || bool || false || TBD (Only for "perspective"/"stereo")
|-
|'''scene.camera.environment.degrees''' || float || 360.0 || TBD (Only for "environment")
|-
|'''scene.camera.lensradius''' || float || 0.0 || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.focaldistance''' || float || 10.0 || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.autofocus.enable''' || bool || false || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.enable''' || bool || false || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.center''' || point (float float float) || 0.0 0.0 0.0 || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|'''scene.camera.clippingplane.normal''' || vector (float float float) || 0.0 0.0 0.0 || TBD (Only for "perspective"/"orthographic"/"stereo")
|-
|}

The camera supports motion blur. See [[ LuxCore_SDL_Reference_Manual_v2.0#Object_Motion_Blur | Object Motion Blur ]]. 
(Only difference being that instead of the prefix '''scene.objects.<object name>''', the prefix '''scene.camera''' is used when setting motion properties of the camera)

==Textures==

Check [[LuxCoreRender_Textures|LuxCoreRender Textures]] for a high level description and examples of the textures.

===Mapping===

Some texture (mostly procedural textures) supports 2D or 3D mapping parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping2d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.rotation''' || float || 0.0 || UV rotation (in degrees)
|-
|'''scene.textures.<texture name>.mapping.uvscale''' || UV || 1.0 1.0 || UV scale
|-
|'''scene.textures.<texture name>.mapping.uvdelta''' || UV || 0.0 0.0 || UV translation
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "globalmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

===Type: add===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "add" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: subtract===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "subtract" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: band===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "band" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5|| texture name or constant
|-
|'''scene.textures.<texture name>.interpolation''' || string || "linear"|| "linear", "cubic" or "none"
|-
|'''scene.textures.<texture name>.offset[0..n]''' || float || 0.0 || multiple offsets in the range of [0.0, 1.0]
|-
|'''scene.textures.<texture name>.value[0..n]''' || spectrum || 1.0 1.0 1.0 || a value for each offset
|}

===Type: blender_blend===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_blend" || type of texture
|-
|'''scene.textures.<texture name>.progressiontype''' || string || "linear" || linear, quadratic, easing, diagonal, spherical, quadratic_spherical, halo or radial
|-
|'''scene.textures.<texture name>.direction''' || string || "horizontal" || horizontal or vertical
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_clouds===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_clouds" || type of texture
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || hard_noise or soft_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_distortednoise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_distortednoise" || type of texture
|-
|'''scene.textures.<texture name>.noise_distortion''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.distortion''' || float || 1 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_magic===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_magic" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_marble===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_marble" || type of texture
|-
|'''scene.textures.<texture name>.marbletype''' || string || "soft" || soft, sharp or sharper
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_musgrave===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_musgrave" || type of texture
|-
|'''scene.textures.<texture name>.musgravetype''' || string || "multifractal" || multifractal, ridged_multifractal, hybrid_multifractal, fBM or hetero_terrain
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.dimension''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.lacunarity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.offset''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.octaves''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_noise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_noise" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_stucci===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_stucci" || type of texture
|-
|'''scene.textures.<texture name>.stuccitype''' || string || "plastic" || plastic, wall_in or wall_out
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_wood===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || bands, rings, bandnoise or ringnoise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_voronoi===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_voronoi" || type of texture
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.distmetric''' || string || "actual_distance" || actual_distance, distance_squared, manhattan, chebychev, minkowski_half, minkowski_four or minkowski
|-
|'''scene.textures.<texture name>.w1''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.w2''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w3''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w4''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: brick===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "brick" || type of texture
|-
|'''scene.textures.<texture name>.bricktex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.mortartex''' || texture || 0.2 0.2 0.2 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodtex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodbias''' || float || 0.0 || With bias = -1, only the bricktex is used for the brick color. With bias between -1 and 1, a pseudo-random interpolation between bricktex and brickmodtex is used as brick color. With bias = 1, only the brickmodtex is used for the brick color.
|-
|'''scene.textures.<texture name>.brickbond''' || string || "running" || "flemish", "english", "herringbone", "basket" or "chain link"
|-
|'''scene.textures.<texture name>.brickwidth''' || float || 0.3 || brick width
|-
|'''scene.textures.<texture name>.brickheight''' || float || 0.1 || brick height
|-
|'''scene.textures.<texture name>.brickdepth''' || float || 0.15 || brick depth
|-
|'''scene.textures.<texture name>.mortarsize''' || float || 0.01 ||mortar size
|-
|'''scene.textures.<texture name>.brickrun''' || float || 0.75 || brick run
|}

This texture supports 3D mapping.

===Type: checkerboard3d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard3d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 3D mapping.

===Type: checkerboard2d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard2d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: constfloat1===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat1" || type of texture
|-
|'''scene.textures.<texture name>.value''' || float || 1.0 || constant value
|}

===Type: constfloat3===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat3" || type of texture
|-
|'''scene.textures.<texture name>.value''' || spectrum || (1.0, 1.0, 1.0) || RGB constant value
|}

===Type: densitygrid===

You can use ".data", ".data3" or ".openvdb.file" to define the 3D grid values.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "densitygrid" || type of texture
|-
|'''scene.textures.<texture name>.nx''' || unsigned int || || grid x size
|-
|'''scene.textures.<texture name>.ny''' || unsigned int || || grid y size
|-
|'''scene.textures.<texture name>.nz''' || unsigned int || || grid z size
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.storage''' || string || "half" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.data''' || float || || vector grid values (total count: nx * ny * nz)
|-
|'''scene.textures.<texture name>.data3''' || float || || vector grid values (total count: nx * ny * nz * 3)
|-
|'''scene.textures.<texture name>.openvdb.file''' || string || || OpenVDB file name
|-
|'''scene.textures.<texture name>.openvdb.grid''' || string || || OpenVDB grid name to read from the file
|}

===Type: dots===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dots" || type of texture
|-
|'''scene.textures.<texture name>.inside''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.outside''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: fbm===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fbm" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: fresnelapproxk===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxk" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: fresnelapproxn===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxn" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: hitpointalpha===

Use the value obtained by interpolating triangle vertices alphas.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointalpha" || type of texture
|}

===Type: hitpointcolor===

Use the color obtained by interpolating triangle vertices colors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointcolor" || type of texture
|}

===Type: hitpointgrey===

Use the value obtained by interpolating triangle vertices colors, mapped to a float value (RGB converted into greyscale).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointgrey" || type of texture
|-
|'''scene.textures.<texture name>.channel''' || int || -1 || the index of the RGB channel to use. -1 means the luminance of the RGB value
|}

===Type: hsv===

Hue saturation value manipulation.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hsv" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input color that will be manipulated
|-
|'''scene.textures.<texture name>.hue''' || texture || 0.5 || shift in hue (range: 0..1)
|-
|'''scene.textures.<texture name>.saturation''' || texture || 1.0 || saturation (range: 0..inf)
|-
|'''scene.textures.<texture name>.value''' || texture || 1.0 || brightness multiplier (range: 0..inf)
|}

===Type: imagemap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "imagemap" || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || "image.png" || name of the image file
|-
|'''scene.textures.<texture name>.gamma''' || float || 2.2 || gamma correction value used in the image
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 || image values are multiplied by gain value
|-
|'''scene.textures.<texture name>.storage''' || string || "auto" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of image map wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.channel''' || string || "default" || extract from the image only the selected channels: "default", "red", "green", "blue", "alpha", "mean", "colored_mean", "rgb"
|}

===Type: normalmap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "normalmap" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input. Is treated as an XYZ vector in tangent space.
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || multiplier for adjusting normalmap height
|}

===Type: marble===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "marble" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || marble scale
|-
|'''scene.textures.<texture name>.variation''' || float || 0.2 || marble variation
|}

This texture supports 3D mapping.

===Type: mix===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "mix" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.texture1''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: scale===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "scale" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: uv===

This procedural texture has no parameters aside from the support of 2D mapping.

===Type: windy===

This procedural texture has no parameters aside from the support of 3D mapping.

===Type: wood===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || "bands", "rings", "bandnoise" or "ringnoise"
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || "sin", "saw" or "tri"
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || "soft_noise" or "hard_noise"
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 || noise size
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 || noise turbulence
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 || bright
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 || contrast
|}

This texture supports 3D mapping.

===Type: wrinkled===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wrinkled" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: abs===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "abs" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|}

===Type: clamp===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "clamp" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.min''' || float || 0.0 || lower boundary of the clamping
|-
|'''scene.textures.<texture name>.max''' || float || 1.0 || upper boundary of the clamping
|}

===Type: divide===

Note: If texture2 (the divisor) is 0, 0 is returned.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "divide" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant (dividend)
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant (divisor)
|}

===Type: remap===

This texture brings the value from the source range into the target range.

Note: The value is clamped into source range before performing the remap operation, and the resulting number is also clamped into the target range.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "remap" || type of texture
|-
|'''scene.textures.<texture name>.value''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemax''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmax''' || texture || 1.0 || texture name or constant
|}

===Type: objectid===

Raw object ID (range 0 to 0xfffffffe).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectid" || type of texture
|}

===Type: objectidcolor===

Object ID interpreted as color. 
The object ID is a 4 byte unsigned int. To convert to color, the lower three bytes are interpreted as r, g, b values (each range 0 to 255). The highest byte is ignored.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidcolor" || type of texture
|}

===Type: objectidnormalized===

Normalized object ID (range 0 to 1).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidnormalized" || type of texture
|}

===Type: dotproduct ===

Dot product of the two input vectors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dotproduct" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: power ===

pow(base, exponent)

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "power" || type of texture
|-
|'''scene.textures.<texture name>.base''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.exponent''' || texture || 1.0 || texture name or constant
|}

===Type: lessthan ===

returns 1 if texture1 < texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lessthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: greaterthan ===

returns 1 if texture1 > texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "greaterthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: shadingnormal ===

Returns the shading normal of the mesh at the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "shadingnormal" || type of texture
|}

===Type: position ===

Returns the position of the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "position" || type of texture
|}

===Type: splitfloat3 ===

Extract a channel from a float3 texture. Can for example be used to get the R, G or B channel of a color texture, or to get the X, Y or Z components of a vector texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "splitfloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.channel''' || int || 0 || the channel to get from the input texture. 0 for first channel, 1 for second, 2 for third channel
|}

===Type: makefloat3 ===

Combine three float textures into one float3 texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "makefloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture3''' || texture || 1.0 || texture name or constant
|}

===Type: blackbody===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blackbody" || type of texture
|-
|'''scene.textures.<texture name>.temperature''' || float || 6500 || emission temperature
|-
|'''scene.textures.<texture name>.normalize''' || bool || false || normalize the output
|}

===Type: irregulardata===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "irregulardata" || type of texture
|-
|'''scene.textures.<texture name>.wavelengths''' || vector || 580.0 620.0 660.0|| wavelenghts
|-
|'''scene.textures.<texture name>.data''' || vector || 0.0 0.000015 0.0|| data (length should match wavelength's length)
|}

===Type: lampspectrum===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lampspectrum" || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || "Daylight" || lamp light spectrum
|}

===Type: Fresnel Textures===

Textures for loading optical data

====Type: fresnelcolor====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelcolor || type of texture
|-
|'''scene.textures.<texture name>.kr''' || vector || 0.5 0.0 0.0 || reflection color
|}

====Type: fresnelpreset====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || aluminium || fresnel preset ("aluminium", "silver", "copper", "gold" or "amorphous carbon")
|}

====Type: fresnelsopra====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Au.nk)
|}

====Type: fresnelluxpop====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Cr.nk)
|}

====Type: distort====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || distort || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0.0 || texture name or constant; input texture
|-
|'''scene.textures.<texture name>.offset''' || texture || 0.0 || texture name or constant; offset to add to the hitpoint coordinates and UV values before evaluating the input texture
|-
|'''scene.textures.<texture name>.strength''' || float || 1.0 || strength multiplier, is multiplied with the offset
|}

==Volumes==

Check [[LuxCoreRender_Volumes|LuxCoreRender Volumes]] for a high level description and examples of the volumes.

All volumes share these properties

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|-
|'''scene.volumes.<volume name>.priority''' || unsigned int|| 0|| volume priority (when volumes overlap, the one with highest priority overrides the others)
|-
|'''scene.volumes.<volume name>.ior''' || texture|| ... || index of refraction
|-
|'''scene.volumes.<volume name>.absorption''' || texture || ... || absorption texture
|-
|'''scene.volumes.<volume name>.emission ''' || texture || ... || emission
|-
|'''scene.volumes.<volume name>.emission.id ''' || unsigned int || ... || emission ID
|}

===Volume: Clear===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|}

===Volume: Homogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || homogeneous|| volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|}

===Volume: Heterogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || heterogeneous || volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|-
|'''scene.volumes.<volume name>.steps.size''' || float || ... || step size
|-
|'''scene.volumes.<volume name>.steps.maxcount''' || unsigned int || ... || step maximum count
|}

==Materials==

Check [[LuxCoreRender_Materials|LuxCoreRender Materials]] for a high level description and examples of the materials.

===Common properties===

Common material properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.bumptex''' || texture || || texture to use for the bump mapping
|-
|'''scene.materials.<material name>.normaltex''' || texture || || texture to use for the normal mapping
|-
|'''scene.materials.<material name>.samples''' || int || -1 || number of rays used to sample this material. -1 means use the default global value. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.diffuse.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.glossy.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.specular.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.bumpsamplingdistance''' || float || 0.001 || set the offset used to sample bump/normal mapping.
|-
|'''scene.materials.<material name>.volume.interior''' || string || vol1 || name of interior volume (for volume rendering)
|-
|'''scene.materials.<material name>.volume.exterior''' || string || vol2 || name of exterior volume (for volume rendering)
|-
|'''scene.materials.<material name>.id''' || int|| ... || material id
|-
|'''scene.materials.<material name>.transparency''' || texture || 1.0 || transparency of the material. 1 for opaque, 0 for fully transparent
|-
|'''scene.materials.<material name>.shadowcatcher.enable''' || bool || false || If true, the material will be transparent where hit by direct light and opaque otherwise (alpha transparency). Used for compositing.
|}

====Normal maps====
Normal maps are set first as a texture type and then assigned to the material. For example:

<blockquote><pre>
scene.textures.normmap.type = imagemap
scene.textures.normmap.file = scenes/bump/normal.png
scene.textures.normmap.gamma = 1

scene.materials.mat_white.type = matte
scene.materials.mat_white.kd = 0.8 0.8 0.8
scene.materials.mat_white.normaltex = normmap
</pre></blockquote>

====Light emission====

All materials can emit light:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.emission''' || texture || 0.0 0.0 0.0 || color of the emitted light
|-
|'''scene.materials.<material name>.emission.gain''' || spectrum || 1.0 1.0 1.0 || multiplier for lamp brigthness
|-
|'''scene.materials.<material name>.emission.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.materials.<material name>.emission.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.materials.<material name>.emission.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light
|-
|'''scene.materials.<material name>.emission.iesblob''' || blob || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.materials.<material name>.emission.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.materials.<material name>.emission.samples''' || int || -1 || the number of shadow ray to trace to compute direct light from this material. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.materials.<material name>.emission.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.
|-
|'''scene.materials.<material name>.emission.theta''' || float || 90.0 || How directional the light is emitted, set as the half-angle of the light source. Default is 90°. Smaller values mean that more light is emitted in the direction of the face normals and less to the sides.
|-
|'''scene.materials.<material name>.emission.importance''' || float || 1.0 || A hint how often to sample this light source compared to other lights
|}

===Type: archglass===

This material should be used to replace glass material of windows when rendering architectural interiors. It allows direct light to pass trough.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "archglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: carpaint===

Car Paint is an advanced glossy material, simulating a diffuse surface with mutliple reflective coatings.

The available presets for the carpaint material are:

*"ford f8"
*"polaris silber"
*"opel titan"
*"bmw339"
*"2k acrylack"
*"white"
*"blue"
*"blue matte"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "carpaint" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "ford f8" || one of the avilable presets
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || absorption color
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || absorption depth
|-
|'''scene.materials.<material name>.kd''' || texture || 0.0 0.0 0.0 || diffuse color
|-
|'''scene.materials.<material name>.ks1''' || texture || 0.0 0.0 0.0 || specular color - layer 1
|-
|'''scene.materials.<material name>.ks2''' || texture || 0.0 0.0 0.0 || specular color - layer 2
|-
|'''scene.materials.<material name>.ks3''' || texture || 0.0 0.0 0.0 || specular color - layer 3
|-
|'''scene.materials.<material name>.r1''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 1
|-
|'''scene.materials.<material name>.r2''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 2
|-
|'''scene.materials.<material name>.r3''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 3
|-
|'''scene.materials.<material name>.m1''' || texture || 0.0 0.0 0.0 || roughness - layer 1
|-
|'''scene.materials.<material name>.m2''' || texture || 0.0 0.0 0.0 || roughness - layer 2
|-
|'''scene.materials.<material name>.m3''' || texture || 0.0 0.0 0.0 || roughness - layer 3
|}

===Type: cloth===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "cloth" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "denim" || denim, silk_charmeuse, silk_shantung, cotton_twill, wool_garbardine or polyester_lining_cloth
|-
|'''scene.materials.<material name>.weft_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in one weave direction
|-
|'''scene.materials.<material name>.weft_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in one weave direction
|-
|'''scene.materials.<material name>.warp_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.warp_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.repeat_u''' || float || 100.0 || thread count in the u direction
|-
|'''scene.materials.<material name>.repeat_v''' || float || 100.0 || thread count in the v direction
|}

===Type: disney===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "disney" || type of material
|-
|'''scene.materials.<material name>.basecolor''' || texture || 0.5 0.5 0.5 || Base color
|-
|'''scene.materials.<material name>.subsurface''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.roughness''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.metallic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.specular''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.speculartint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoat''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoatgloss''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.anisotropic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheen''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheentint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.filmamount''' || texture || none || Linear interpolation between no film (0) and full film effect (1) for artistic control. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.cauchyb''' || texture || 0.0 || if defined and > 0.0, enable dispersion. The value is the B term of the [https://en.wikipedia.org/wiki/Cauchy%27s_equation Cauchy's equation]
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glossy2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossy2" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossytranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossytranslucent" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmission color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.ks_bf''' || texture || 0.5 0.5 0.5 || texture or constant backface specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.uroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.vroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.ka_bf''' || texture || 0.0 0.0 0.0 || texture or constant value of backface coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.d_bf''' || texture || 0.0 || texture or constant value of the backface depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.index_bf''' || texture || 0.0 0.0 0.0 || IOR of the backface coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|-
|'''scene.materials.<material name>.multibounce_bf''' || bool || false || backface simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossycoating===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossycoating" || type of material
|-
|'''scene.materials.<material name>.base''' || string || || name of base material, the coating layer is added on top of this material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: matte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "matte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the matte material
|}

===Type: mattetranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mattetranslucent" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 0.5 0.5 0.5 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmitted color of the material
|}

===Type: metal2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "metal2" || type of material
|-
|'''scene.materials.<material name>.fresnel''' || fresnel texture || ... || [[#Type:_Fresnel_Textures | fresnel texture]]
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.preset''' || string || "aluminium" || (DEPRECATED) "aluminium", "silver", "copper", "gold" or "amorphous carbon"
|-
|'''scene.materials.<material name>.n''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxn texture on overwrite the .preset property
|-
|'''scene.materials.<material name>.k''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxk texture on overwrite the .preset property
|}

===Type: mirror===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mirror" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|}

===Type: mix===

This material can be used to mix 2 other materials.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mix" || type of material
|-
|'''scene.materials.<material name>.material1''' || string || mat1 || name of another material
|-
|'''scene.materials.<material name>.material2''' || string || mat2 || name of another material
|-
|'''scene.materials.<material name>.amount''' || texture || 0.5 || texture or constant value used to mix the materials
|}

===Type: null===

This is empty, not visible material. It can be combined by using mix material with others. It is often used in combination with the alpha channel of an image map to render leafs, etc.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "null" || type of material
|}

===Type: roughglass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: roughmatte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughmatte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the roughmatte material
|-
|'''scene.materials.<material name>.sigma''' || texture || 0.0 || the sigma parameter in the Oren-Nayer shader in degrees. Zero for pure Lambertian reflection
|}

===Type: velvet===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "velvet" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || color of the material's fuzz
|-
|'''scene.materials.<material name>.p1''' || texture || -2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p2''' || texture || 20.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p3''' || texture || 2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.thickness''' || texture || 0.1 || height of the fuzz
|}

==Objects==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.material''' || string || || type of object material
|-
|'''scene.objects.<object name>.shape''' || string || || name of [[#Shapes | shape]] with the triangle mesh description.Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same shape, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.ply''' || string || || '''(Deprecated, use .shape instead)''' name of [http://en.wikipedia.org/wiki/PLY_(file_format) PLY] file with the triangle mesh description. Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same file, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.objects.<object name>.vertices''' || float || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of float values defining the vertices of the mesh (i.e. 3 coordinates for each vertex).
|-
|'''scene.objects.<object name>.faces''' || unsigned int || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of unsigned int values defining the triangles of the mesh (i.e. 3 index of vertices for each triangle).
|-
|'''scene.objects.<object name>.id''' || unsigned int || || object ID
|-
|'''scene.objects.<object name>.camerainvisible''' || bool || false || toggle visibility for camera rays. If set to true, the object will not show up in camera rays, but it will still be visible in reflections, refractions, shadows, indirect light etc.
|}

===Object Motion Blur===

LuxCore supports transformation motion blur for objects.
Motion blur is enabled if an object has a motion system defined as described below.

A motion system consists of steps (at least 2). Each step has a time (in seconds) and a transformation matrix of the object at this point in time.
Step indices start at 0. The times have to be monotonic (each greater than the last).

Note that the embree accelerator only supports a maximum of 129 time steps.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.motion.<step>.time''' || float || || time (in seconds) of the step
|-
|'''scene.objects.<object name>.motion.<step>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix of the object at the given step
|-
|}

==Shapes==

===Type: mesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "mesh" || mesh shape
|-
|'''scene.shapes.<shape name>.ply''' || string || ... || mesh path (e.g ''scenes/luxball/luxball-shell.ply'')
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: inlinedmesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "inlinedmesh" || inlinedmesh shape
|-
|'''scene.shapes.<shape name>.vertices''' || vector || ... || inlinedmesh vertices (e.g 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0 0.0)
|-
|'''scene.shapes.<shape name>.faces''' || vector || ... || inlinedmesh faces (e.g 0 1 2)
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: pointiness===

Contains surface curvature information in vertex alpha channel. 
You can access this information in materials via a hitpointalpha texture. 
The values range from -1 to 1 (float). 
Values from -1 to 0 are concave, while values from 0 to 1 are convex.

[[ Shape:_Pointiness | Examples ]]

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "pointiness" || pointiness shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || pointiness source (a mesh shape)
|}

===Type: strands===

Can be used for hair, fur, grass etc. 
Note that you need to define the camera before defining any strands shapes, because the tesselation process is viewpoint-dependent.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "strands" || strands shape
|-
|'''scene.shapes.<shape name>.file''' || string || ... || strands file (''scenes/strands/straight.hair'')
|}

====Strands tessellation methods====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbon" || ribbon tessellation
|-
|'''scene.shapes.<shape name>.tessellation.usecameraposition''' || bool || 1 || use camera position
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbonadaptive" || ribbon adaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.maxdepth''' || unsigned int || 12 || max tessellation depth
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.error ''' || float || 0.0075 || max tessellation error
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solid" || solid tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solid.sidecount ''' || unsigned int || 12 || tessellation's side count
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solidadaptive" || solidadaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.sidecount ''' || unsigned int || 8 || tessellation's side count
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.maxdepth''' || unsigned int || 16 || tessellation's max depth
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.error''' || float || 0.05 || tessellation's max error
|}

===Type: group===

Todo.

===Type: displacement===

Todo.

===Type: subdiv===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "subdiv" || subdivided shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || source mesh name
|-
|'''scene.shapes.<shape name>.maxlevel''' || unsigned integer || 2 || maximum level of subdivision
|-
|'''scene.shapes.<shape name>.maxedgescreensize''' || float || 0.0 || maximum edge screen size
|-
|'''scene.shapes.<shape name>.adaptive''' || bool || 1 || Adaptive refinement / Uniform refinement
|}

===Type: harlequin===

Todo.

===Type: simplify===

Todo.

===Type: islandaov===

Todo.

===Type: randomtriangleaov===

Todo.

==Light sources==

Check [[Lighting|LuxCoreRender Lighting]] for an high level description and example of the light sources.

===Common parameters===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.gain''' || spectrum || 1.0 1.0 1.0 || intensity of the light
|-
|'''scene.lights.<light name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.lights.<light name>.samples''' || int || -1 || the number of shadow ray to trace to compute direct light for this light source. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.

|-
|'''scene.lights.<light name>.importance''' || float || 1.0 || A hint how often to sample this light compared to other lights
|}

===Type: sun===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sun" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.relsize''' || float || 1.0 || relative size to the sun
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sky2===

Hosek-Wilkie sky model.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sky2" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.gain''' || vector || ... || gain
|-
|'''scene.lights.<light name>.groundalbedo''' || vector || 0.5 0.5 0.5 || ground albedo
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.ground.enable''' || bool || 1 || enable ground color
|-
|'''scene.lights.<light name>.ground.color''' || vector|| ... || RGB ground color
|}

===Type: infinite===

Spherical lightsource surrounding the scene at infinite distance. 
Used for image based lighting (IBL) and HDR environment lighting if the file is a high dynamic range image.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "infinite" || type of light
|-
|'''scene.lights.<light name>.file''' || string || "image.png" || filename of the environment map
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma correction used by the image map
|-
|'''scene.lights.<light name>.storage''' || string || "auto" || environment map storage type ("auto", "byte", "half" or "float")
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.sampleupperhemisphereonly''' || bool || false || an option set to black the lower hemisphere. Mostly useful for shadow catchers.
|}

===Type: point===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "point" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mappoint===

Point light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mappoint" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: sphere===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mapsphere===

Sphere light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mapsphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: spot===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "spot" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.coneangle''' || float || 30.0 || angle in degrees of the spotlight cone
|-
|'''scene.lights.<light name>.conedeltaangle''' || float || 5.0 || angle at which the spotlight intensity starts to fade from the edge
|}

===Type: projection===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "projection" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.fov''' || float || 45.0 || field of view in terms of angular spread along the shorter image axis
|-
|'''scene.lights.<light name>.mapfile''' || string || || filename of the image to project. If not specified, a constat light color will be used.
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|}

===Type: constantinfinite===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "constantinfinite" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sharpdistant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sharpdistant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|}

===Type: distant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "distant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|-
|'''scene.lights.<light name>.theta''' || float || 10.0 || half angle of the light source in degree. Must be > 0 for soft shadows
|}

===Type: laser===

A light source emitting parallel light rays (like sharpdistant light, but starting inside the scene instead of infinitely far away).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "laser" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.radius''' || float || 0.01 || radius of the laser beam
|}

LuxCore SDL Reference Manual v2.11

2026-06-07T09:22:23Z

CodeHD: /* Camera */

The scene description language (SDL) is used to configure the renderer and to define objects, materials, textures etc. in the scene. 
The file ending of the render configuration file is ".cfg", for the scene file it's ".scn".

These files are usually created by exporter plugins, e.g. BlendLuxCore. 
This wiki page is primarily a reference for exporter developers, normal end-users should not need to edit cfg/scn files by hand.

Sometimes the API is updated faster than the wiki, in this case you can look at the code directly: https://github.com/LuxCoreRender/LuxCore/tree/master/src/slg/scene

Note that matrices are passed as flat lists in column-major form.

=Render configuration file=

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''resumerendering.filesafe''' || bool || 1 || enable/disable "safe save" mode for resume rendering file. A backup of the output is always valid even in the case of a system failure
|}

==Seed==

The global seed value that is used to generate random numbers. 
Two images rendered with the same seed will have the same noise pattern.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.seed''' || unsigned int || 1 || min 1
|}

==Periodic save==

Options related to periodic save operations.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''periodicsave.resumerendering.period''' || float || 0 || save the resume rendering file every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.resumerendering.filename''' || string || "resume.rsm" || the name to use to save the rendering resume information periodically
|-
|'''periodicsave.film.period''' || float || 0 || save the Film every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.film.filename''' || string || "film.flm" || the name to use to save the film periodically
|-
|'''periodicsave.film.outputs.period''' || float || 600 || save all Film outputs every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|}

==Render Engine==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.type''' || string || "PATHCPU" || engine type
|}

=== CPU Render Engines ===

CPU render engines are written in C++ and don't require OpenCL. All CPU render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''native.threads.count''' || int || CPU core count || > 0 || > 0 || The number of threads will be used for the rendering
|}

'''The following CPU engines are available:'''

===="PATHCPU"====

A path tracer with full image plane rendering (i.e. supporting Metropolis sampler).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|}

===="TILEPATHCPU"====
Biased path tracer with many control options and support for tile rendering. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|-
|'''tilepath.sampling.aa.size''' || int || 3 || > 0 || [1, 13] || All diffuse/glossy/specular samples are multiplied with the squared aa size: final_samples = aa^2 * (diffuse^2 + glossy^2 + specular^2)
|-
|'''tile.size''' || int || 32 || ≥ 8 || [8, 256] || Tile size in pixels
|-
|'''tile.multipass.enable''' || bool || 1 || 0 or 1 || o or 1 || Re-render the image until a halt threshold is met or indefinitely
|-
|'''tile.multipass.convergencetest.threshold''' || float || 6.0 / 256.0 || > 0.0 || [1.0 / 256.0, 6.0 / 256.0] || Target noise level
|-
|'''tile.multipass.convergencetest.threshold.reduction''' || float || 0.0 || [0.0, 1.0] || [0.75, 0.95] || Multiply noise level with this number when all tiles have met the previous noise level. Set to 0 to disable (so rendering will stop at the noise level)
|-
|'''tile.multipass.convergencetest.warmup.count''' || int || 32 || ≥ 0 || [8, 128] || Warm up period for the convergence test expressed in samples per pixel
|}

===="BIDIRCPU"====

A Bidirectional path tracer.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a eye path
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

===="RTPATHCPU"====
Engine optimized for interactive scene editing and camera movement. 
The sampler must be set to RTPATHCPUSAMPLER when using this engine.

Supports the same properties as [[#"PATHCPU" | "PATHCPU"]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpathcpu.zoomphase.size''' || int || 4 || || || render scaled down film for the first few frames after a scene edit (to make interactions more fluid)
|-
|'''rtpathcpu.zoomphase.weight''' || float || 0.1 || || || description: TODO
|}

=== OpenCL Render Engines ===

OpenCL engines can run on GPUs, CPUs and other types of computing devices, they require OpenCL to run. All OpenCL render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''opencl.platform.index''' || int || -1 || A valid platform index || -1 || Select the OpenCL platform to use. All devices available on all platforms will be used with -1
|-
|'''opencl.cpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL CPU devices available
|-
|'''opencl.gpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL GPU devices available
|-
|'''opencl.cpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.gpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.devices.select''' || string || "" || Any valid selection string || Any valid selection string || Select each OpenCL device to use. It is a string of "0" and "1". "1" means use the device, "0" do not
|}

'''The following OpenCL engines are available:'''

===="PATHOCL"====
OpenCL version of PATHCPU. Supports the same settings as [[#"PATHCPU" | PATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''pathocl.pixelatomics.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable pixel atomic operation
|-
|'''opencl.task.count''' || int || "AUTO" || "AUTO" or > 0 || [64K, 1024K] || The number of tasks sent to the OpenCL device in one kernel call
|}

===="RTPATHOCL"====

A PATHOCL version optimized for real-time rendering with fixed frame-rate and variable quality. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"PATHOCL" | PATHOCL]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpath.resolutionreduction.preview''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels in the first passes. For instance 4x4 than 2x2 and than always 1x1
|-
|'''rtpath.resolutionreduction.preview.step''' || int || 8 || > 0 || [1, 32] || Each preview step is rendered for n frames
|-
|'''rtpath.resolutionreduction''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels, outside the preview phase, in order to reduce the per frame rendering time
|}

===="TILEPATHOCL"====

OpenCL version of TILEPATHCPU. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"TILEPATHCPU" | TILEPATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''tilepathocl.devices.maxtiles''' || int || 16 || ≥ 1 || [1, 32] || Maximum number of tiles to send in a single call to each OpenCL device
|}

==="FILESAVER"===

Saves everything needed to render the scene to the output path, including textures and meshes.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''filesaver.format''' || string || "TXT" || "TXT" for a text SDL format and "BIN" for a single file binary format
|-
|'''filesaver.filename''' || string || "luxcore-exported-scene.bcf" || file name for "BIN" format
|-
|'''filesaver.directory''' || string || "luxcore-exported-scene" || output path for "TXT" format
|-
|'''filesaver.renderengine.type''' || string || "PATHCPU" || render engine to use when rendering the scene after it was saved with FILESAVER. Any engine string from above can be used here.
|}

===Experimental and debugging engines===

'''These engines are experimental, deprecated or are only intended for very specific purposes:'''

===="BIDIRVMCPU"====

Bidir with vertex merging, currently experimental. 
Supports the same settings as [[#"BIDIRCPU" | BIDIRCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''bidirvm.lightpath.count''' || int || 16 * 1024 || > 0 || || Number of lightpaths per pass
|-
|'''bidirvm.startradius.scale''' || float || 0.003 || > 0 || || Photon radius of the first pass
|-
|'''bidirvm.alpha''' || float || 3 || > 0 || [0.0, 1.0] || Photon radius is multiplied with this value after every pass to reduce the radius
|}

===="LIGHTCPU"====

For testing.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''light.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''light.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

==Sampler==

Samplers are used by following render engines:

* LIGHTCPU
* PATHCPU
* BIDIRCPU
* BIDIRVMCPU
* PATHOCL

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''sampler.type''' || string || "SOBOL" || sampler type
|}

The following samplers are available:

==="SOBOL"===

Sampler with sobol pattern.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.sobol.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==="METROPOLIS"===

Metropolis sampler.
Parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.metropolis.largesteprate''' || float || 0.4 || 0 ≤ x ≤ 1 || 0 - 1 || Probability of generating a large sample mutation
|-
|'''sampler.metropolis.maxconsecutivereject''' || int || 512 || x ≥ 0 || 0 - 32768 || Number of consecutive rejects before a next mutation is forced. Low values can cause bias
|-
|'''sampler.metropolis.imagemutationrate''' || float || 0.1 || 0 ≤ x ≤ 1 || 0 - 1 || Maximum distance over the image plane for a small mutation
|}

==="RANDOM"===

Fully random sampler. This sampler is mostly intended for testing purpose.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.random.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==Filter==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.type''' || string || "BLACKMANHARRIS" || || || Type of pixel filter.
|-
|'''film.filter.width''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Filter radius in pixels. Does not have an effect on the NONE filter
|-
|'''film.filter.xwidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|-
|'''film.filter.ywidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|}

Available filters are:

==="NONE"===

Disable pixel filtering.

==="BOX"===

Box pixel filter. No parameters.

==="GAUSSIAN"===

Gaussian pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.gaussian.alpha''' || float || 2.0 || x > 0.0 || 0.1 - 10.0 || Gaussian rate of falloff. Lower values give blurrier images.
|}

==="MITCHELL"===

Mitchel pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchell.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchell.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="MITCHELL_SS"===

Mitchel pixel filter with super-sampling (i.e. image will be filtered first with a grid of 4 pixels for each pixel).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchellss.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchellss.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="BLACKMANHARRIS"===

Blcakman-Harris pixel filter. No parameters.

==Light Strategy==

The direct light sampling strategy is defined by the following property:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.type''' || string || "LOG_POWER" || "UNIFORM", "POWER", "LOG_POWER" or "DLS_CACHE" || N/A || Direct light sampling strategy
|}

==="UNIFORM"===

"UNIFORM" light strategy samples evenly all light sources.

==="POWER"===

"POWER" light strategy samples the light sources based on their power.

==="LOG_POWER"===

"LOG_POWER" light strategy samples the light sources based on logarithm of their power.

==="DLS_CACHE"===

Build direct light sampling cache to optimize many-lights rendering, beneficial in scenes with multiple light sources with few overlap between their influence areas (e.g. a building with many disconnected rooms and interior lights).

Options for the DLS cache:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.entry.radius''' || float || 0.0 || || N/A || Entry radius in meters, automatic radius estimation is used if the radius is set to 0
|-
|'''lightstrategy.entry.normalangle''' || float || 25.0 || || N/A ||
|-
|'''lightstrategy.entry.maxpasses''' || int || 1024 || || N/A ||
|-
|'''lightstrategy.entry.convergencethreshold''' || float || 0.05 || || N/A ||
|-
|'''lightstrategy.entry.warmupsamples''' || int || 24 || || N/A ||
|-
|'''lightstrategy.targetcachehitratio''' || float || 0.995 || || N/A ||
|-
|'''lightstrategy.maxdepth''' || int || 4 || || N/A ||
|-
|'''lightstrategy.maxsamplescount''' || int || 10000000 || || N/A ||
|-
|'''lightstrategy.persistent.file''' || string || "" || || N/A ||
|-
|'''lightstrategy.persistent.safesave''' || bool || 1 || || N/A ||

|}

==Accelerator==

The ray/triangle intersection accelerator to use for the rendering is defined by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''accelerator.type''' || string || "AUTO" || "AUTO", "BVH", "MBVH", "EMBREE" || "AUTO" || The intersection accelerator. "AUTO" will select the best one available for the current [[LuxRays]] intersection device. "EMBREE" is currently usable only on CPU render engines
|-
|'''accelerator.instances.enable''' || bool || 1 || 0 or 1 || 0 or 1 || Enable instance support (or disable in order to slightly increase rendering speed)
|}

==Epsilon==

Minimum and maximum allowed value for scene epsilon can be define by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''scene.epsilon.min''' || float || 1e-5f || Any float value || 1e-6f ≤ x ≤ 1e-1f || Minimum allowed value for scene epsilon
|-
|'''scene.epsilon.max''' || float || 1e-1f || Any float value || 1e-3f ≤ x ≤ 1e+2f || Maximum allowed value for scene epsilon
|}

==Film==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.safesave''' || bool || 1 || enable "safe save" of Film serialization. A backup of the output is always valid even in the case of a system failure.
|}

===Film OpenCL Options===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.opencl.enable''' || bool || 1 || enable OpenCL film operations
|-
|'''film.opencl.platform''' || unsigned int || -1 || choose which platform will be used by the film operations. (0 is first platform, 1 second and so on. -1 for all)
|-
|'''film.opencl.device''' || unsigned int || -1 || choose which device will be used by the film operations. (0 is first device, 1 second and so on. -1 for first GPU device)
|}

===Film Outputs (aka AOVs)===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.safesave''' || bool || 1 || enable "safe save" for Film outputs. A backup of the output is always valid even in the case of a system failure
|}

The film object supports many types of outputs (aka AOVs). The complete list of supported output types:

{| class="wikitable" cellspacing="2"
!Name
!Type
|-
|'''RGB''' || HDR
|-
|'''RGBA''' || HDR
|-
|'''RGB_IMAGEPIPELINE''' || HDR/LDR
|-
|'''RGBA_IMAGEPIPELINE''' || HDR/LDR
|-
|'''ALPHA''' || HDR/LDR
|-
|'''DEPTH''' || HDR
|-
|'''POSITION''' || HDR
|-
|'''GEOMETRY_NORMAL''' || HDR
|-
|'''SHADING_NORMAL''' || HDR
|-
|'''MATERIAL_ID''' || LDR
|-
|'''DIRECT_DIFFUSE''' || HDR
|-
|'''DIRECT_GLOSSY''' || HDR
|-
|'''EMISSION''' || HDR
|-
|'''INDIRECT_DIFFUSE''' || HDR
|-
|'''INDIRECT_GLOSSY''' || HDR
|-
|'''INDIRECT_SPECULAR''' || HDR
|-
|'''MATERIAL_ID_MASK''' || HDR/LDR
|-
|'''DIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''INDIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''RADIANCE_GROUP''' || HDR/LDR
|-
|'''UV''' || HDR/LDR
|-
|'''RAYCOUNT''' || HDR/LDR
|-
|'''BY_MATERIAL_ID''' || HDR/LDR
|-
|'''IRRADIANCE''' || HDR
|-
|'''OBJECT_ID''' || LDR
|-
|'''OBJECT_ID_MASK''' || HDR/LDR
|-
|'''BY_OBJECT_ID''' || HDR/LDR
|-
|'''SAMPLECOUNT''' || HDR/LDR
|-
|'''CONVERGENCE''' || HDR/LDR
|-
|'''NOISE''' || HDR/LDR
|-
|'''SERIALIZED_FILM''' || N/A
|-
|'''MATERIAL_ID_COLOR''' || HDR/LDR
|}

Outputs are enabled with the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.<index>.type''' || string || || Type of output, e.g. "RGBA" or "ALPHA" (see the list above for the available types)
|-
|'''film.outputs.<index>.filename''' || string || || Filename to use when saving the output. The filename should use ".exr" as extension for HDR outputs and ".png" for LDR outputs (see list above for which output is HDR and which LDR)
|-
|'''film.outputs.<index>.id''' || int || || Specify for the following outputs: '''MATERIAL_ID_MASK''', '''RADIANCE_GROUP''', '''BY_MATERIAL_ID''', '''OBJECT_ID_MASK''', '''BY_OBJECT_ID''' (to choose the object ID, material ID or radiance group ID of the output)
|-
|'''film.outputs.<index>.index''' || int || || Specify for an imagepipeline output (RGB_IMAGEPIPELINE or RGBA_IMAGEPIPELINE) to select the imagepipeline of the output. For example, if you have 3 imagepipelines defined, and you want to specify the output of the third imagepipeline, use 2 for the ".index" property of the output
|}

Note that the Bidir engine does not support all AOVs.
Not supported by Bidir are: EMISSION, DIRECT_DIFFUSE, DIRECT_GLOSSY, INDIRECT_DIFFUSE, INDIRECT_GLOSSY, INDIRECT_SPECULAR, DIRECT_SHADOW_MASK, INDIRECT_SHADOW_MASK, IRRADIANCE, RAYCOUNT.

This is the list of output channel data types and sizes:

{| class="wikitable" cellspacing="2"
!Output type
!Data type
!Size
!Description
|-
|RGB||float||film width x film height x 3||R, G, B
|-
|RGB_IMAGEPIPELINE||float||film width x film height x 3||R, G, B
|-
|RGBA||float||film width x film height x 4||R, G, B, A
|-
|ALPHA||float||film width x film height x 1||Alpha value [0, 1]
|-
|DEPTH||float||film width x film height x 1||Camera distance
|-
|POSITION||float||film width x film height x 3||World X, Y, Z
|-
|GEOMETRY_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|SHADING_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|DIRECT_DIFFUSE||float||film width x film height x 3||Diffuse R, G, B
|-
|DIRECT_GLOSSY||float||film width x film height x 3||Glossy R, G, B
|-
|EMISSION||float||film width x film height x 3||Emission R, G, B
|-
|INDIRECT_DIFFUSE||float||film width x film height x 3||Indirect diffuse R, G, B
|-
|INDIRECT_GLOSSY||float||film width x film height x 3||Indirect glossy R, G, B
|-
|INDIRECT_SPECULAR||float||film width x film height x 3||Indirect specular R, G, B
|-
|MATERIAL_ID_MASK||float||film width x film height x 1||Material mask [0, 1]
|-
|DIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|INDIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|RADIANCE_GROUP||float||film width x film height x 3||R, G, B
|-
|UV||float||film width x film height x 2||Texture coordinates U, V
|-
|RAYCOUNT||float||film width x film height x 1||Ray count
|-
|BY_MATERIAL_ID||float||film width x film height x 3||By material ID
|-
|MATERIAL_ID||uint||film width x film height x 1||Material ID
|-
|IRRADIANCE||float||film width x film height x 3||R, G, B
|-
|OBJECT_ID_MASK||float||film width x film height x 1||Object mask [0, 1]
|-
|BY_OBJECT_ID||float||film width x film height x 3||By object ID
|-
|OBJECT_ID||uint||film width x film height x 1||Object ID
|-
|SAMPLECOUNT||uint||film width x film height x 1||Sample count
|-
|CONVERGENCE||float||film width x film height x 1||The distance of each pixel from the convergence threshold
|-
|NOISE||float||film width x film height x 1||The noise estimated for each pixel
|-
|SERIALIZED_FILM||N/A||N/A||The complete Film serialized in binary format
|-
|MATERIAL_ID_COLOR||float||film width x film height x 3||Material ID converted to colors (with anti-aliasing)
|}

===Film Channels===

Film channels are implicitly enabled by declaring film outputs (even if the output is never used). For instance, declaring a "RGBA" output will automatically enable "RADIANCE_PER_PIXEL_NORMALIZED" (and "RADIANCE_PER_SCREEN_NORMALIZED" for BIDIRCPU) and "ALPHA".
The supported channels are:

{| class="wikitable" cellspacing="2"
!Channel type
!Data type
!Size
!Last element is weight ?
!Note
|-
|CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED||float||film width x film height x 4||Yes||One for each radiance group. Eye paths radiance.
|-
|CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED||float||film width x film height x 3||No||One for each radiance group. Light paths radiance. Used only by LIGHTCPU and BIDIRCPU.
|-
|CHANNEL_ALPHA||float||film width x film height x 2||Yes||
|-
|CHANNEL_RGB_IMAGEPIPELINE||float||film width x film height x 3||No||
|-
|CHANNEL_DEPTH||float||film width x film height x 1||No||
|-
|CHANNEL_POSITION||float||film width x film height x 3||No||
|-
|CHANNEL_GEOMETRY_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_SHADING_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_MATERIAL_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_DIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_DIRECT_GLOSSY||float||film width x film height x 4||Yes||
|-
|CHANNEL_EMISSION||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_SPECULAR||float||film width x film height x 4||Yes||
|-
|CHANNEL_MATERIAL_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_DIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_INDIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_UV||float||film width x film height x 2||No||
|-
|CHANNEL_RAYCOUNT||float||film width x film height||No||
|-
|CHANNEL_BY_MATERIAL_ID||float||film width x film height x 4||Yes||
|-
|CHANNEL_IRRADIANCE||float||film width x film height x 4||Yes||
|-
|CHANNEL_OBJECT_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_OBJECT_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_BY_OBJECT_ID||float||film width x film height x 4||Yes||
|}

This is the list of channels enabled by each output:

{| class="wikitable" cellspacing="2"
!Output
!Enabled channels
|-
|'''RGB''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''RGB_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''ALPHA''' || ALPHA
|-
|'''DEPTH''' || DEPTH
|-
|'''POSITION''' || DEPTH, POSITION
|-
|'''GEOMETRY_NORMAL''' || DEPTH, GEOMETRY_NORMAL
|-
|'''SHADING_NORMAL''' || DEPTH, SHADING_NORMAL
|-
|'''MATERIAL_ID''' || DEPTH, MATERIAL_ID
|-
|'''DIRECT_DIFFUSE''' || DIRECT_DIFFUSE
|-
|'''DIRECT_GLOSSY''' || DIRECT_GLOSSY
|-
|'''EMISSION''' || EMISSION
|-
|'''INDIRECT_DIFFUSE''' || INDIRECT_DIFFUSE
|-
|'''INDIRECT_GLOSSY''' || INDIRECT_GLOSSY
|-
|'''INDIRECT_SPECULAR''' || INDIRECT_SPECULAR
|-
|'''MATERIAL_ID_MASK''' || MATERIAL_ID, MATERIAL_ID_MASK
|-
|'''DIRECT_SHADOW_MASK''' || DIRECT_SHADOW_MASK
|-
|'''INDIRECT_SHADOW_MASK''' || INDIRECT_SHADOW_MASK
|-
|'''RADIANCE_GROUP''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''UV''' || DEPTH, UV
|-
|'''RAYCOUNT''' || DEPTH, RAYCOUNT
|-
|'''BY_MATERIAL_ID''' || BY_MATERIAL_ID
|-
|'''IRRADIANCE''' || IRRADIANCE
|-
|'''OBJECT_ID''' || DEPTH, OBJECT_ID
|-
|'''OBJECT_ID_MASK''' || OBJECT_ID, OBJECT_ID_MASK
|-
|'''BY_OBJECT_ID''' || BY_OBJECT_ID
|}

Note: CHANNEL_RGB_IMAGEPIPELINE is always enable and the result of running the image pipeline.

===Image pipeline===

It is possible to define multiple image pipelines at the same time by using the '''film.imagepipelines.<pipeline #>.''' properties prefix. Each image pipeline takes as input the raw rendering and is a chain off image pipeline plugins. Each plugin receives previous plugin output and produces a new output.

====Radiance Group====

Radiance groups are used to get only the contribution of a group of lights in the scene. 
Lights can be grouped by setting their [[#Common_parameters | '''.id''']] property to the same number, on materials this is done with the [[#Light_emission | '''.emission.id''']] property. 

Note that the OpenCL engines only support up to 8 radiance groups (one of them is the default group).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.globalscale''' || float|| 1 || global weighting of radiance group
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.temperature ''' || float || 6500.0 || light temperature
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.rgbscale''' || vector || 1.0 1.0 1.0 || light color
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.radiancescales.<id>.enabled''' || bool || 1 || enable radiance group
|}

====Image pipeline plug-ins====

=====Type: TONEMAP_LINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || linear tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 1.0 || tonemapping scale
|}

=====Type: TONEMAP_REINHARD02=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_REINHARD02" || reinhard tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.prescale''' || float || 1.0 || reinhard prescale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.postscale''' || float || 1.2 || reinhard postscale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.burn''' || float || 3.75 || reinhard burn
|}

=====Type: TONEMAP_AUTOLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_AUTOLINEAR" || automatic linear tonemapping
|}

=====Type: TONEMAP_LUXLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LUXLINEAR" || linear tonemapping with real camera settings
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sensitivity''' || float || 100.0 || ISO sensitivity
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.exposure''' || float || 0.001 || exposure time
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.fstop''' || float || 2.8 || f/aperture
|}

=====Type: NOP=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipeline.<pipeline #>.<plugin #>.type''' || string || "NOP" || no parameters tonemapper
|}

=====Type: GAMMA_CORRECTION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || gamma correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.value''' || float || 2.2 || gamma value
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.table.size''' || unsigned int || 4096 || resolution
|}

=====Type: OUTPUT_SWITCHER=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OUTPUT_SWITCHER" || overwrite output
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.channel''' || string || "DEPTH" || channel whose values are used to overwrite
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.index''' || unsigned int || 0 || index
|}

=====Type: GAUSSIANFILTER_3x3=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "GAUSSIANFILTER_3x3" || gaussian filter
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.15 || blurring weight
|}

=====Type: CAMERA_RESPONSE_FUNC=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || CAMERA_RESPONSE_FUNC || analog camera film simulation
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.name''' || string || "Advantix_100CD" || film type
|}

=====Type: BACKGROUND_IMG=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || BACKGROUND_IMG || show the background image where alpha < 1 (simple compositing)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || ... || background image path (e.g scenes/simple-mat/sky.exr)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.gamma''' || float || 2.2 || background image gamma
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.storage ''' || string || auto || background image storage type
|}
Note: When the size of the background image differs from the film size, it will be stretched to fit the film size.

=====Type: BLOOM=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "BLOOM" || bloom effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.radius''' || float || 0.07 || how large the bloom effect is in % of the image size (i.e. 1.0 = all image)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.25 || how strong the effect is (i.e. 0.0 = nothing, 1.0 = max. strength)
|}

=====Type: VIGNETTING=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "VIGNETTING" || vignetting effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 0.4 || vignetting strength
|}

=====Type: COLOR_ABERRATION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_ABERRATION" || color aberration effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || color aberration amount
|}

=====Type: MIST=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "MIST" || aerial perspective effect (fake fog)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.color''' || spectrum|| [1, 1, 1] || mist color
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || mist amount
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.startdistance''' || float || 0 || distance from camera until where the mist effect has zero effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.enddistance''' || float || 10000 || distance from camera from where the mist effect has maximum effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.excludebackground''' || bool || false || Do not apply mist effect on pixels with infinite distance to the camera
|}

=====Type: CONTOUR_LINES=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "CONTOUR_LINES" || contour lines for IRRADIANCE AOV
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.range''' || float|| ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.steps''' || int || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.zerogridsize''' || int || ? || ?
|}

=====Type: WHITE_BALANCE =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "WHITE_BALANCE" || White temperature correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.temperature''' || unsigned int|| 6500 || Target image temperature in Kelvin
|-
|}

=====Type: COLOR_LUT =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_LUT" || Applies .cube LUT (look-up-table) to the input
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || "lut.cube" || Filepath to a [https://wwwimages2.adobe.com/content/dam/acom/en/products/speedgrade/cc/pdfs/cube-lut-specification-1.0.pdf .cube LUT file]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.strength''' || float || 1.0 || Linear interpolation between input (0.0) and output (1.0) of the plugin
|-
|}

=====Type: INTEL_OIDN =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "INTEL_OIDN" || Denoises the image using [https://github.com/OpenImageDenoise/oidn Intel OIDN]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.filter.type''' || string || "RT" ||
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.oidnmemory''' || int || 6000 || Approximate maximum amount of memory to use in megabytes (actual memory usage may be higher). Limiting memory usage may cause slower denoising due to internally splitting the image into overlapping tiles
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

=====Type: OPTIX_DENOISER =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OPTIX_DENOISER" || Denoises the image using the Nvidia OptiX denoiser
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.minspp''' || unsigned int || 0 || Minimum amount of samples to be rendered before the plugin is run (at lower sample numbers, it does not modify the input)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

===Film Subregion===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.subregion''' || vector || ... || <xstart> <xstop> <ystart> <ystop>
|}

===Rendering halt conditions===

By default, a LuxCore rendering will never stop however you can enable one or multiple halt conditions:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''batch.haltnoisethreshold''' || float || -1.0 || enable image convergence test and stops when the error is under the defined value. Use a value like "n / 256.0" where n is the level of error you are looking for. It may be hard to achieve a level of error smaller than 3.0 / 256.0. -1.0 disables the halt condition.
|-
|'''batch.haltnoisethreshold.warmup''' || unsigned int || 64 || number of average samples per pixel before to start the convergence test
|-
|'''batch.haltnoisethreshold.step''' || unsigned int || 64 || number of average samples per pixel between two tests
|-
|'''batch.haltnoisethreshold.filter.enable''' || bool || 1 || if the CONVERGENCE AOV (generated by the batch.haltnoisethreshold) should be filtered or not with a 3x3 box filter
|-
|'''batch.haltnoisethreshold.stoprendering.enable''' || bool || 1 || Set this to 0 (false) if you only want to use the haltnoisethreshold settings for adaptive sampling in an endless render
|-
|'''batch.haltnoisethreshold.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for stopping
|-
|'''batch.halttime''' || float || 0.0 || number of seconds before stopping the rendering
|-
|'''batch.haltspp''' || unsigned int || 0 || number of average samples per pixel before stopping the rendering
|}

===Noise estimation===

Image noise can be estimated and its result can be used to drive the Sobol and Random samplers to focus its sampling in the noisier regions.
Setting any of these properties will enable the noise estimation.
The adaptiveness strength is a Sampler property.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.noiseestimation.warmup''' || unsigned int || 32 || number of average samples per pixel before to start the convergence test
|-
|'''film.noiseestimation.step''' || unsigned int || 32 || number of average samples per pixel between two tests
|-
|'''film.noiseestimation.filter.scale''' || unsigned int || 4 || Box filter scale used to filter the NOISE AOV (generated by the noise estimation). Set to 0 to disable.
|-
|'''film.noiseestimation.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for adaptive sampling
|-
|}

=Scene file=

==Camera==

General parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.type''' || string || "perspective" || "perspective", "orthographic", "environment" (360° panorama mapped in latlong format) or "stereo"
|-
|'''scene.camera.lookat.orig''' || point (float float float) || 0.0 10.0 0.0 || camera location
|-
|'''scene.camera.lookat.target''' || point (float float float) || 0.0 0.0 0.0 || camera target
|-
|'''scene.camera.up''' || vector (float float float) || (0.0, 0.0, 1.0) || camera up vector
|-
|'''scene.camera.fieldofview''' || float || 45.0 || field of view
|-
|'''scene.camera.shutteropen''' || float || 0.0 || camera shutter open time (used for motion blur)
|-
|'''scene.camera.shutterclose''' || float || 0.0 || camera shutter close time (used for motion blur)
|-
|'''scene.camera.autovolume.enable''' || bool || true || try automatically to discover scene.camera.volume
|-
|'''scene.camera.volume''' || string || || the initial volume rays will travel in
|-
|'''scene.camera.cliphither''' || float || 1e-3 || TBD
|-
|'''scene.camera.clipyon''' || float || 1e30 || TBD
|-
|}

Parameters only applicable if scene.camera.type == "orthographic" or "perspective" or "environment"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.screenwindow''' || list (float float float float) || 0.0 1.0 0.0 1.0 || <xstart> <xstop> <ystart> <ystop>
|-
|}

Parameters only applicable if scene.camera.type == "perspective"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.bokeh.distribution.type''' || string || NONE || "NONE", "UNIFORM", "EXPONENTIAL", "INVERSEEXPONENTIAL", "GAUSSIAN", "INVERSEGAUSSIAN", "TRIANGULAR", "CUSTOM"
|-
|'''scene.camera.bokeh.blades''' || int || 0 || Number of aperture blades
|-
|'''scene.camera.bokeh.power''' || int || 3 || Distribution factor, only for "EXPONENTIAL" and "INVERSEEXPONENTIAL" types
|-
|'''scene.camera.bokeh.distribution.image''' || string || "image.png" || only if type == "CUSTOM"
|-
|'''scene.camera.bokeh.scalex''' || float || 1.0 || TBD
|-
|'''scene.camera.bokeh.scaley''' || float || 1.0 || TBD
|-
|}

Parameters only applicable if scene.camera.type == "stereo"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.stereo.type''' || string || "perspective" || "perspective", "environment_180", "environment_360"
|-
|'''scene.camera.eyesdistance''' || float || 0.0626 || TBD
|-
|'''scene.camera.lensdistance''' || float || 0.2779 || TBD
|-
|}

Parameters only applicable if scene.camera.type == "perspective" or "stereo"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.oculusrift.barrelpostpro.enable''' || bool || false || TBD
|-
|}

Parameters only applicable if scene.camera.type == "environment"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.environment.degrees''' || float || 360.0 || TBD
|-
|}

Parameters only applicable if scene.camera.type != "environment"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.lensradius''' || float || 0.0 || TBD
|-
|'''scene.camera.focaldistance''' || float || 10.0 || TBD
|-
|'''scene.camera.autofocus.enable''' || bool || false || TBD
|-
|'''scene.camera.clippingplane.enable''' || bool || false || TBD
|-
|'''scene.camera.clippingplane.center''' || point (float float float) || 0.0 0.0 0.0 || TBD
|-
|'''scene.camera.clippingplane.normal''' || vector (float float float) || 0.0 0.0 0.0 || TBD
|-
|}

The camera supports motion blur. See [[ LuxCore_SDL_Reference_Manual_v2.0#Object_Motion_Blur | Object Motion Blur ]]. 
(Only difference being that instead of the prefix '''scene.objects.<object name>''', the prefix '''scene.camera''' is used when setting motion properties of the camera)

==Textures==

Check [[LuxCoreRender_Textures|LuxCoreRender Textures]] for a high level description and examples of the textures.

===Mapping===

Some texture (mostly procedural textures) supports 2D or 3D mapping parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping2d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.rotation''' || float || 0.0 || UV rotation (in degrees)
|-
|'''scene.textures.<texture name>.mapping.uvscale''' || UV || 1.0 1.0 || UV scale
|-
|'''scene.textures.<texture name>.mapping.uvdelta''' || UV || 0.0 0.0 || UV translation
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "globalmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

===Type: add===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "add" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: subtract===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "subtract" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: band===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "band" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5|| texture name or constant
|-
|'''scene.textures.<texture name>.interpolation''' || string || "linear"|| "linear", "cubic" or "none"
|-
|'''scene.textures.<texture name>.offset[0..n]''' || float || 0.0 || multiple offsets in the range of [0.0, 1.0]
|-
|'''scene.textures.<texture name>.value[0..n]''' || spectrum || 1.0 1.0 1.0 || a value for each offset
|}

===Type: blender_blend===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_blend" || type of texture
|-
|'''scene.textures.<texture name>.progressiontype''' || string || "linear" || linear, quadratic, easing, diagonal, spherical, quadratic_spherical, halo or radial
|-
|'''scene.textures.<texture name>.direction''' || string || "horizontal" || horizontal or vertical
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_clouds===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_clouds" || type of texture
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || hard_noise or soft_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_distortednoise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_distortednoise" || type of texture
|-
|'''scene.textures.<texture name>.noise_distortion''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.distortion''' || float || 1 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_magic===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_magic" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_marble===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_marble" || type of texture
|-
|'''scene.textures.<texture name>.marbletype''' || string || "soft" || soft, sharp or sharper
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_musgrave===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_musgrave" || type of texture
|-
|'''scene.textures.<texture name>.musgravetype''' || string || "multifractal" || multifractal, ridged_multifractal, hybrid_multifractal, fBM or hetero_terrain
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.dimension''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.lacunarity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.offset''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.octaves''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_noise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_noise" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_stucci===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_stucci" || type of texture
|-
|'''scene.textures.<texture name>.stuccitype''' || string || "plastic" || plastic, wall_in or wall_out
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_wood===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || bands, rings, bandnoise or ringnoise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_voronoi===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_voronoi" || type of texture
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.distmetric''' || string || "actual_distance" || actual_distance, distance_squared, manhattan, chebychev, minkowski_half, minkowski_four or minkowski
|-
|'''scene.textures.<texture name>.w1''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.w2''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w3''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w4''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: brick===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "brick" || type of texture
|-
|'''scene.textures.<texture name>.bricktex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.mortartex''' || texture || 0.2 0.2 0.2 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodtex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodbias''' || float || 0.0 || With bias = -1, only the bricktex is used for the brick color. With bias between -1 and 1, a pseudo-random interpolation between bricktex and brickmodtex is used as brick color. With bias = 1, only the brickmodtex is used for the brick color.
|-
|'''scene.textures.<texture name>.brickbond''' || string || "running" || "flemish", "english", "herringbone", "basket" or "chain link"
|-
|'''scene.textures.<texture name>.brickwidth''' || float || 0.3 || brick width
|-
|'''scene.textures.<texture name>.brickheight''' || float || 0.1 || brick height
|-
|'''scene.textures.<texture name>.brickdepth''' || float || 0.15 || brick depth
|-
|'''scene.textures.<texture name>.mortarsize''' || float || 0.01 ||mortar size
|-
|'''scene.textures.<texture name>.brickrun''' || float || 0.75 || brick run
|}

This texture supports 3D mapping.

===Type: checkerboard3d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard3d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 3D mapping.

===Type: checkerboard2d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard2d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: constfloat1===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat1" || type of texture
|-
|'''scene.textures.<texture name>.value''' || float || 1.0 || constant value
|}

===Type: constfloat3===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat3" || type of texture
|-
|'''scene.textures.<texture name>.value''' || spectrum || (1.0, 1.0, 1.0) || RGB constant value
|}

===Type: densitygrid===

You can use ".data", ".data3" or ".openvdb.file" to define the 3D grid values.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "densitygrid" || type of texture
|-
|'''scene.textures.<texture name>.nx''' || unsigned int || || grid x size
|-
|'''scene.textures.<texture name>.ny''' || unsigned int || || grid y size
|-
|'''scene.textures.<texture name>.nz''' || unsigned int || || grid z size
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.storage''' || string || "half" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.data''' || float || || vector grid values (total count: nx * ny * nz)
|-
|'''scene.textures.<texture name>.data3''' || float || || vector grid values (total count: nx * ny * nz * 3)
|-
|'''scene.textures.<texture name>.openvdb.file''' || string || || OpenVDB file name
|-
|'''scene.textures.<texture name>.openvdb.grid''' || string || || OpenVDB grid name to read from the file
|}

===Type: dots===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dots" || type of texture
|-
|'''scene.textures.<texture name>.inside''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.outside''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: fbm===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fbm" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: fresnelapproxk===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxk" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: fresnelapproxn===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxn" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: hitpointalpha===

Use the value obtained by interpolating triangle vertices alphas.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointalpha" || type of texture
|}

===Type: hitpointcolor===

Use the color obtained by interpolating triangle vertices colors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointcolor" || type of texture
|}

===Type: hitpointgrey===

Use the value obtained by interpolating triangle vertices colors, mapped to a float value (RGB converted into greyscale).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointgrey" || type of texture
|-
|'''scene.textures.<texture name>.channel''' || int || -1 || the index of the RGB channel to use. -1 means the luminance of the RGB value
|}

===Type: hsv===

Hue saturation value manipulation.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hsv" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input color that will be manipulated
|-
|'''scene.textures.<texture name>.hue''' || texture || 0.5 || shift in hue (range: 0..1)
|-
|'''scene.textures.<texture name>.saturation''' || texture || 1.0 || saturation (range: 0..inf)
|-
|'''scene.textures.<texture name>.value''' || texture || 1.0 || brightness multiplier (range: 0..inf)
|}

===Type: imagemap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "imagemap" || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || "image.png" || name of the image file
|-
|'''scene.textures.<texture name>.gamma''' || float || 2.2 || gamma correction value used in the image
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 || image values are multiplied by gain value
|-
|'''scene.textures.<texture name>.storage''' || string || "auto" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of image map wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.channel''' || string || "default" || extract from the image only the selected channels: "default", "red", "green", "blue", "alpha", "mean", "colored_mean", "rgb"
|}

===Type: normalmap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "normalmap" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input. Is treated as an XYZ vector in tangent space.
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || multiplier for adjusting normalmap height
|}

===Type: marble===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "marble" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || marble scale
|-
|'''scene.textures.<texture name>.variation''' || float || 0.2 || marble variation
|}

This texture supports 3D mapping.

===Type: mix===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "mix" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.texture1''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: scale===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "scale" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: uv===

This procedural texture has no parameters aside from the support of 2D mapping.

===Type: windy===

This procedural texture has no parameters aside from the support of 3D mapping.

===Type: wood===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || "bands", "rings", "bandnoise" or "ringnoise"
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || "sin", "saw" or "tri"
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || "soft_noise" or "hard_noise"
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 || noise size
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 || noise turbulence
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 || bright
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 || contrast
|}

This texture supports 3D mapping.

===Type: wrinkled===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wrinkled" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: abs===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "abs" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|}

===Type: clamp===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "clamp" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.min''' || float || 0.0 || lower boundary of the clamping
|-
|'''scene.textures.<texture name>.max''' || float || 1.0 || upper boundary of the clamping
|}

===Type: divide===

Note: If texture2 (the divisor) is 0, 0 is returned.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "divide" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant (dividend)
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant (divisor)
|}

===Type: remap===

This texture brings the value from the source range into the target range.

Note: The value is clamped into source range before performing the remap operation, and the resulting number is also clamped into the target range.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "remap" || type of texture
|-
|'''scene.textures.<texture name>.value''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemax''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmax''' || texture || 1.0 || texture name or constant
|}

===Type: objectid===

Raw object ID (range 0 to 0xfffffffe).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectid" || type of texture
|}

===Type: objectidcolor===

Object ID interpreted as color. 
The object ID is a 4 byte unsigned int. To convert to color, the lower three bytes are interpreted as r, g, b values (each range 0 to 255). The highest byte is ignored.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidcolor" || type of texture
|}

===Type: objectidnormalized===

Normalized object ID (range 0 to 1).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidnormalized" || type of texture
|}

===Type: dotproduct ===

Dot product of the two input vectors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dotproduct" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: power ===

pow(base, exponent)

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "power" || type of texture
|-
|'''scene.textures.<texture name>.base''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.exponent''' || texture || 1.0 || texture name or constant
|}

===Type: lessthan ===

returns 1 if texture1 < texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lessthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: greaterthan ===

returns 1 if texture1 > texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "greaterthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: shadingnormal ===

Returns the shading normal of the mesh at the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "shadingnormal" || type of texture
|}

===Type: position ===

Returns the position of the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "position" || type of texture
|}

===Type: splitfloat3 ===

Extract a channel from a float3 texture. Can for example be used to get the R, G or B channel of a color texture, or to get the X, Y or Z components of a vector texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "splitfloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.channel''' || int || 0 || the channel to get from the input texture. 0 for first channel, 1 for second, 2 for third channel
|}

===Type: makefloat3 ===

Combine three float textures into one float3 texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "makefloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture3''' || texture || 1.0 || texture name or constant
|}

===Type: blackbody===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blackbody" || type of texture
|-
|'''scene.textures.<texture name>.temperature''' || float || 6500 || emission temperature
|-
|'''scene.textures.<texture name>.normalize''' || bool || false || normalize the output
|}

===Type: irregulardata===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "irregulardata" || type of texture
|-
|'''scene.textures.<texture name>.wavelengths''' || vector || 580.0 620.0 660.0|| wavelenghts
|-
|'''scene.textures.<texture name>.data''' || vector || 0.0 0.000015 0.0|| data (length should match wavelength's length)
|}

===Type: lampspectrum===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lampspectrum" || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || "Daylight" || lamp light spectrum
|}

===Type: Fresnel Textures===

Textures for loading optical data

====Type: fresnelcolor====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelcolor || type of texture
|-
|'''scene.textures.<texture name>.kr''' || vector || 0.5 0.0 0.0 || reflection color
|}

====Type: fresnelpreset====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || aluminium || fresnel preset ("aluminium", "silver", "copper", "gold" or "amorphous carbon")
|}

====Type: fresnelsopra====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Au.nk)
|}

====Type: fresnelluxpop====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Cr.nk)
|}

====Type: distort====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || distort || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0.0 || texture name or constant; input texture
|-
|'''scene.textures.<texture name>.offset''' || texture || 0.0 || texture name or constant; offset to add to the hitpoint coordinates and UV values before evaluating the input texture
|-
|'''scene.textures.<texture name>.strength''' || float || 1.0 || strength multiplier, is multiplied with the offset
|}

==Volumes==

Check [[LuxCoreRender_Volumes|LuxCoreRender Volumes]] for a high level description and examples of the volumes.

All volumes share these properties

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|-
|'''scene.volumes.<volume name>.priority''' || unsigned int|| 0|| volume priority (when volumes overlap, the one with highest priority overrides the others)
|-
|'''scene.volumes.<volume name>.ior''' || texture|| ... || index of refraction
|-
|'''scene.volumes.<volume name>.absorption''' || texture || ... || absorption texture
|-
|'''scene.volumes.<volume name>.emission ''' || texture || ... || emission
|-
|'''scene.volumes.<volume name>.emission.id ''' || unsigned int || ... || emission ID
|}

===Volume: Clear===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|}

===Volume: Homogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || homogeneous|| volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|}

===Volume: Heterogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || heterogeneous || volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|-
|'''scene.volumes.<volume name>.steps.size''' || float || ... || step size
|-
|'''scene.volumes.<volume name>.steps.maxcount''' || unsigned int || ... || step maximum count
|}

==Materials==

Check [[LuxCoreRender_Materials|LuxCoreRender Materials]] for a high level description and examples of the materials.

===Common properties===

Common material properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.bumptex''' || texture || || texture to use for the bump mapping
|-
|'''scene.materials.<material name>.normaltex''' || texture || || texture to use for the normal mapping
|-
|'''scene.materials.<material name>.samples''' || int || -1 || number of rays used to sample this material. -1 means use the default global value. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.diffuse.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.glossy.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.specular.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.bumpsamplingdistance''' || float || 0.001 || set the offset used to sample bump/normal mapping.
|-
|'''scene.materials.<material name>.volume.interior''' || string || vol1 || name of interior volume (for volume rendering)
|-
|'''scene.materials.<material name>.volume.exterior''' || string || vol2 || name of exterior volume (for volume rendering)
|-
|'''scene.materials.<material name>.id''' || int|| ... || material id
|-
|'''scene.materials.<material name>.transparency''' || texture || 1.0 || transparency of the material. 1 for opaque, 0 for fully transparent
|-
|'''scene.materials.<material name>.shadowcatcher.enable''' || bool || false || If true, the material will be transparent where hit by direct light and opaque otherwise (alpha transparency). Used for compositing.
|}

====Normal maps====
Normal maps are set first as a texture type and then assigned to the material. For example:

<blockquote><pre>
scene.textures.normmap.type = imagemap
scene.textures.normmap.file = scenes/bump/normal.png
scene.textures.normmap.gamma = 1

scene.materials.mat_white.type = matte
scene.materials.mat_white.kd = 0.8 0.8 0.8
scene.materials.mat_white.normaltex = normmap
</pre></blockquote>

====Light emission====

All materials can emit light:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.emission''' || texture || 0.0 0.0 0.0 || color of the emitted light
|-
|'''scene.materials.<material name>.emission.gain''' || spectrum || 1.0 1.0 1.0 || multiplier for lamp brigthness
|-
|'''scene.materials.<material name>.emission.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.materials.<material name>.emission.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.materials.<material name>.emission.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light
|-
|'''scene.materials.<material name>.emission.iesblob''' || blob || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.materials.<material name>.emission.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.materials.<material name>.emission.samples''' || int || -1 || the number of shadow ray to trace to compute direct light from this material. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.materials.<material name>.emission.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.
|-
|'''scene.materials.<material name>.emission.theta''' || float || 90.0 || How directional the light is emitted, set as the half-angle of the light source. Default is 90°. Smaller values mean that more light is emitted in the direction of the face normals and less to the sides.
|-
|'''scene.materials.<material name>.emission.importance''' || float || 1.0 || A hint how often to sample this light source compared to other lights
|}

===Type: archglass===

This material should be used to replace glass material of windows when rendering architectural interiors. It allows direct light to pass trough.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "archglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: carpaint===

Car Paint is an advanced glossy material, simulating a diffuse surface with mutliple reflective coatings.

The available presets for the carpaint material are:

*"ford f8"
*"polaris silber"
*"opel titan"
*"bmw339"
*"2k acrylack"
*"white"
*"blue"
*"blue matte"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "carpaint" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "ford f8" || one of the avilable presets
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || absorption color
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || absorption depth
|-
|'''scene.materials.<material name>.kd''' || texture || 0.0 0.0 0.0 || diffuse color
|-
|'''scene.materials.<material name>.ks1''' || texture || 0.0 0.0 0.0 || specular color - layer 1
|-
|'''scene.materials.<material name>.ks2''' || texture || 0.0 0.0 0.0 || specular color - layer 2
|-
|'''scene.materials.<material name>.ks3''' || texture || 0.0 0.0 0.0 || specular color - layer 3
|-
|'''scene.materials.<material name>.r1''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 1
|-
|'''scene.materials.<material name>.r2''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 2
|-
|'''scene.materials.<material name>.r3''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 3
|-
|'''scene.materials.<material name>.m1''' || texture || 0.0 0.0 0.0 || roughness - layer 1
|-
|'''scene.materials.<material name>.m2''' || texture || 0.0 0.0 0.0 || roughness - layer 2
|-
|'''scene.materials.<material name>.m3''' || texture || 0.0 0.0 0.0 || roughness - layer 3
|}

===Type: cloth===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "cloth" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "denim" || denim, silk_charmeuse, silk_shantung, cotton_twill, wool_garbardine or polyester_lining_cloth
|-
|'''scene.materials.<material name>.weft_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in one weave direction
|-
|'''scene.materials.<material name>.weft_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in one weave direction
|-
|'''scene.materials.<material name>.warp_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.warp_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.repeat_u''' || float || 100.0 || thread count in the u direction
|-
|'''scene.materials.<material name>.repeat_v''' || float || 100.0 || thread count in the v direction
|}

===Type: disney===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "disney" || type of material
|-
|'''scene.materials.<material name>.basecolor''' || texture || 0.5 0.5 0.5 || Base color
|-
|'''scene.materials.<material name>.subsurface''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.roughness''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.metallic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.specular''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.speculartint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoat''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoatgloss''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.anisotropic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheen''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheentint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.filmamount''' || texture || none || Linear interpolation between no film (0) and full film effect (1) for artistic control. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.cauchyb''' || texture || 0.0 || if defined and > 0.0, enable dispersion. The value is the B term of the [https://en.wikipedia.org/wiki/Cauchy%27s_equation Cauchy's equation]
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glossy2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossy2" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossytranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossytranslucent" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmission color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.ks_bf''' || texture || 0.5 0.5 0.5 || texture or constant backface specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.uroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.vroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.ka_bf''' || texture || 0.0 0.0 0.0 || texture or constant value of backface coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.d_bf''' || texture || 0.0 || texture or constant value of the backface depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.index_bf''' || texture || 0.0 0.0 0.0 || IOR of the backface coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|-
|'''scene.materials.<material name>.multibounce_bf''' || bool || false || backface simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossycoating===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossycoating" || type of material
|-
|'''scene.materials.<material name>.base''' || string || || name of base material, the coating layer is added on top of this material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: matte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "matte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the matte material
|}

===Type: mattetranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mattetranslucent" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 0.5 0.5 0.5 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmitted color of the material
|}

===Type: metal2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "metal2" || type of material
|-
|'''scene.materials.<material name>.fresnel''' || fresnel texture || ... || [[#Type:_Fresnel_Textures | fresnel texture]]
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.preset''' || string || "aluminium" || (DEPRECATED) "aluminium", "silver", "copper", "gold" or "amorphous carbon"
|-
|'''scene.materials.<material name>.n''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxn texture on overwrite the .preset property
|-
|'''scene.materials.<material name>.k''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxk texture on overwrite the .preset property
|}

===Type: mirror===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mirror" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|}

===Type: mix===

This material can be used to mix 2 other materials.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mix" || type of material
|-
|'''scene.materials.<material name>.material1''' || string || mat1 || name of another material
|-
|'''scene.materials.<material name>.material2''' || string || mat2 || name of another material
|-
|'''scene.materials.<material name>.amount''' || texture || 0.5 || texture or constant value used to mix the materials
|}

===Type: null===

This is empty, not visible material. It can be combined by using mix material with others. It is often used in combination with the alpha channel of an image map to render leafs, etc.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "null" || type of material
|}

===Type: roughglass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: roughmatte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughmatte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the roughmatte material
|-
|'''scene.materials.<material name>.sigma''' || texture || 0.0 || the sigma parameter in the Oren-Nayer shader in degrees. Zero for pure Lambertian reflection
|}

===Type: velvet===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "velvet" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || color of the material's fuzz
|-
|'''scene.materials.<material name>.p1''' || texture || -2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p2''' || texture || 20.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p3''' || texture || 2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.thickness''' || texture || 0.1 || height of the fuzz
|}

==Objects==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.material''' || string || || type of object material
|-
|'''scene.objects.<object name>.shape''' || string || || name of [[#Shapes | shape]] with the triangle mesh description.Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same shape, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.ply''' || string || || '''(Deprecated, use .shape instead)''' name of [http://en.wikipedia.org/wiki/PLY_(file_format) PLY] file with the triangle mesh description. Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same file, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.objects.<object name>.vertices''' || float || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of float values defining the vertices of the mesh (i.e. 3 coordinates for each vertex).
|-
|'''scene.objects.<object name>.faces''' || unsigned int || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of unsigned int values defining the triangles of the mesh (i.e. 3 index of vertices for each triangle).
|-
|'''scene.objects.<object name>.id''' || unsigned int || || object ID
|-
|'''scene.objects.<object name>.camerainvisible''' || bool || false || toggle visibility for camera rays. If set to true, the object will not show up in camera rays, but it will still be visible in reflections, refractions, shadows, indirect light etc.
|}

===Object Motion Blur===

LuxCore supports transformation motion blur for objects.
Motion blur is enabled if an object has a motion system defined as described below.

A motion system consists of steps (at least 2). Each step has a time (in seconds) and a transformation matrix of the object at this point in time.
Step indices start at 0. The times have to be monotonic (each greater than the last).

Note that the embree accelerator only supports a maximum of 129 time steps.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.motion.<step>.time''' || float || || time (in seconds) of the step
|-
|'''scene.objects.<object name>.motion.<step>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix of the object at the given step
|-
|}

==Shapes==

===Type: mesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "mesh" || mesh shape
|-
|'''scene.shapes.<shape name>.ply''' || string || ... || mesh path (e.g ''scenes/luxball/luxball-shell.ply'')
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: inlinedmesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "inlinedmesh" || inlinedmesh shape
|-
|'''scene.shapes.<shape name>.vertices''' || vector || ... || inlinedmesh vertices (e.g 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0 0.0)
|-
|'''scene.shapes.<shape name>.faces''' || vector || ... || inlinedmesh faces (e.g 0 1 2)
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: pointiness===

Contains surface curvature information in vertex alpha channel. 
You can access this information in materials via a hitpointalpha texture. 
The values range from -1 to 1 (float). 
Values from -1 to 0 are concave, while values from 0 to 1 are convex.

[[ Shape:_Pointiness | Examples ]]

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "pointiness" || pointiness shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || pointiness source (a mesh shape)
|}

===Type: strands===

Can be used for hair, fur, grass etc. 
Note that you need to define the camera before defining any strands shapes, because the tesselation process is viewpoint-dependent.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "strands" || strands shape
|-
|'''scene.shapes.<shape name>.file''' || string || ... || strands file (''scenes/strands/straight.hair'')
|}

====Strands tessellation methods====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbon" || ribbon tessellation
|-
|'''scene.shapes.<shape name>.tessellation.usecameraposition''' || bool || 1 || use camera position
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbonadaptive" || ribbon adaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.maxdepth''' || unsigned int || 12 || max tessellation depth
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.error ''' || float || 0.0075 || max tessellation error
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solid" || solid tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solid.sidecount ''' || unsigned int || 12 || tessellation's side count
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solidadaptive" || solidadaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.sidecount ''' || unsigned int || 8 || tessellation's side count
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.maxdepth''' || unsigned int || 16 || tessellation's max depth
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.error''' || float || 0.05 || tessellation's max error
|}

===Type: group===

Todo.

===Type: displacement===

Todo.

===Type: subdiv===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "subdiv" || subdivided shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || source mesh name
|-
|'''scene.shapes.<shape name>.maxlevel''' || unsigned integer || 2 || maximum level of subdivision
|-
|'''scene.shapes.<shape name>.maxedgescreensize''' || float || 0.0 || maximum edge screen size
|-
|'''scene.shapes.<shape name>.adaptive''' || bool || 1 || Adaptive refinement / Uniform refinement
|}

===Type: harlequin===

Todo.

===Type: simplify===

Todo.

===Type: islandaov===

Todo.

===Type: randomtriangleaov===

Todo.

==Light sources==

Check [[Lighting|LuxCoreRender Lighting]] for an high level description and example of the light sources.

===Common parameters===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.gain''' || spectrum || 1.0 1.0 1.0 || intensity of the light
|-
|'''scene.lights.<light name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.lights.<light name>.samples''' || int || -1 || the number of shadow ray to trace to compute direct light for this light source. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.

|-
|'''scene.lights.<light name>.importance''' || float || 1.0 || A hint how often to sample this light compared to other lights
|}

===Type: sun===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sun" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.relsize''' || float || 1.0 || relative size to the sun
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sky2===

Hosek-Wilkie sky model.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sky2" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.gain''' || vector || ... || gain
|-
|'''scene.lights.<light name>.groundalbedo''' || vector || 0.5 0.5 0.5 || ground albedo
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.ground.enable''' || bool || 1 || enable ground color
|-
|'''scene.lights.<light name>.ground.color''' || vector|| ... || RGB ground color
|}

===Type: infinite===

Spherical lightsource surrounding the scene at infinite distance. 
Used for image based lighting (IBL) and HDR environment lighting if the file is a high dynamic range image.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "infinite" || type of light
|-
|'''scene.lights.<light name>.file''' || string || "image.png" || filename of the environment map
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma correction used by the image map
|-
|'''scene.lights.<light name>.storage''' || string || "auto" || environment map storage type ("auto", "byte", "half" or "float")
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.sampleupperhemisphereonly''' || bool || false || an option set to black the lower hemisphere. Mostly useful for shadow catchers.
|}

===Type: point===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "point" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mappoint===

Point light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mappoint" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: sphere===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mapsphere===

Sphere light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mapsphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: spot===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "spot" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.coneangle''' || float || 30.0 || angle in degrees of the spotlight cone
|-
|'''scene.lights.<light name>.conedeltaangle''' || float || 5.0 || angle at which the spotlight intensity starts to fade from the edge
|}

===Type: projection===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "projection" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.fov''' || float || 45.0 || field of view in terms of angular spread along the shorter image axis
|-
|'''scene.lights.<light name>.mapfile''' || string || || filename of the image to project. If not specified, a constat light color will be used.
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|}

===Type: constantinfinite===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "constantinfinite" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sharpdistant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sharpdistant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|}

===Type: distant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "distant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|-
|'''scene.lights.<light name>.theta''' || float || 10.0 || half angle of the light source in degree. Must be > 0 for soft shadows
|}

===Type: laser===

A light source emitting parallel light rays (like sharpdistant light, but starting inside the scene instead of infinitely far away).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "laser" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.radius''' || float || 0.01 || radius of the laser beam
|}

LuxCore SDL Reference Manual v2.11

2026-06-06T15:32:47Z

CodeHD: /* Camera */ add missing parameters (need better grouping and descriptions)

The scene description language (SDL) is used to configure the renderer and to define objects, materials, textures etc. in the scene. 
The file ending of the render configuration file is ".cfg", for the scene file it's ".scn".

These files are usually created by exporter plugins, e.g. BlendLuxCore. 
This wiki page is primarily a reference for exporter developers, normal end-users should not need to edit cfg/scn files by hand.

Sometimes the API is updated faster than the wiki, in this case you can look at the code directly: https://github.com/LuxCoreRender/LuxCore/tree/master/src/slg/scene

Note that matrices are passed as flat lists in column-major form.

=Render configuration file=

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''resumerendering.filesafe''' || bool || 1 || enable/disable "safe save" mode for resume rendering file. A backup of the output is always valid even in the case of a system failure
|}

==Seed==

The global seed value that is used to generate random numbers. 
Two images rendered with the same seed will have the same noise pattern.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.seed''' || unsigned int || 1 || min 1
|}

==Periodic save==

Options related to periodic save operations.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''periodicsave.resumerendering.period''' || float || 0 || save the resume rendering file every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.resumerendering.filename''' || string || "resume.rsm" || the name to use to save the rendering resume information periodically
|-
|'''periodicsave.film.period''' || float || 0 || save the Film every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.film.filename''' || string || "film.flm" || the name to use to save the film periodically
|-
|'''periodicsave.film.outputs.period''' || float || 600 || save all Film outputs every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|}

==Render Engine==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.type''' || string || "PATHCPU" || engine type
|}

=== CPU Render Engines ===

CPU render engines are written in C++ and don't require OpenCL. All CPU render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''native.threads.count''' || int || CPU core count || > 0 || > 0 || The number of threads will be used for the rendering
|}

'''The following CPU engines are available:'''

===="PATHCPU"====

A path tracer with full image plane rendering (i.e. supporting Metropolis sampler).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|}

===="TILEPATHCPU"====
Biased path tracer with many control options and support for tile rendering. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|-
|'''tilepath.sampling.aa.size''' || int || 3 || > 0 || [1, 13] || All diffuse/glossy/specular samples are multiplied with the squared aa size: final_samples = aa^2 * (diffuse^2 + glossy^2 + specular^2)
|-
|'''tile.size''' || int || 32 || ≥ 8 || [8, 256] || Tile size in pixels
|-
|'''tile.multipass.enable''' || bool || 1 || 0 or 1 || o or 1 || Re-render the image until a halt threshold is met or indefinitely
|-
|'''tile.multipass.convergencetest.threshold''' || float || 6.0 / 256.0 || > 0.0 || [1.0 / 256.0, 6.0 / 256.0] || Target noise level
|-
|'''tile.multipass.convergencetest.threshold.reduction''' || float || 0.0 || [0.0, 1.0] || [0.75, 0.95] || Multiply noise level with this number when all tiles have met the previous noise level. Set to 0 to disable (so rendering will stop at the noise level)
|-
|'''tile.multipass.convergencetest.warmup.count''' || int || 32 || ≥ 0 || [8, 128] || Warm up period for the convergence test expressed in samples per pixel
|}

===="BIDIRCPU"====

A Bidirectional path tracer.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a eye path
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

===="RTPATHCPU"====
Engine optimized for interactive scene editing and camera movement. 
The sampler must be set to RTPATHCPUSAMPLER when using this engine.

Supports the same properties as [[#"PATHCPU" | "PATHCPU"]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpathcpu.zoomphase.size''' || int || 4 || || || render scaled down film for the first few frames after a scene edit (to make interactions more fluid)
|-
|'''rtpathcpu.zoomphase.weight''' || float || 0.1 || || || description: TODO
|}

=== OpenCL Render Engines ===

OpenCL engines can run on GPUs, CPUs and other types of computing devices, they require OpenCL to run. All OpenCL render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''opencl.platform.index''' || int || -1 || A valid platform index || -1 || Select the OpenCL platform to use. All devices available on all platforms will be used with -1
|-
|'''opencl.cpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL CPU devices available
|-
|'''opencl.gpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL GPU devices available
|-
|'''opencl.cpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.gpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.devices.select''' || string || "" || Any valid selection string || Any valid selection string || Select each OpenCL device to use. It is a string of "0" and "1". "1" means use the device, "0" do not
|}

'''The following OpenCL engines are available:'''

===="PATHOCL"====
OpenCL version of PATHCPU. Supports the same settings as [[#"PATHCPU" | PATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''pathocl.pixelatomics.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable pixel atomic operation
|-
|'''opencl.task.count''' || int || "AUTO" || "AUTO" or > 0 || [64K, 1024K] || The number of tasks sent to the OpenCL device in one kernel call
|}

===="RTPATHOCL"====

A PATHOCL version optimized for real-time rendering with fixed frame-rate and variable quality. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"PATHOCL" | PATHOCL]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpath.resolutionreduction.preview''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels in the first passes. For instance 4x4 than 2x2 and than always 1x1
|-
|'''rtpath.resolutionreduction.preview.step''' || int || 8 || > 0 || [1, 32] || Each preview step is rendered for n frames
|-
|'''rtpath.resolutionreduction''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels, outside the preview phase, in order to reduce the per frame rendering time
|}

===="TILEPATHOCL"====

OpenCL version of TILEPATHCPU. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"TILEPATHCPU" | TILEPATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''tilepathocl.devices.maxtiles''' || int || 16 || ≥ 1 || [1, 32] || Maximum number of tiles to send in a single call to each OpenCL device
|}

==="FILESAVER"===

Saves everything needed to render the scene to the output path, including textures and meshes.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''filesaver.format''' || string || "TXT" || "TXT" for a text SDL format and "BIN" for a single file binary format
|-
|'''filesaver.filename''' || string || "luxcore-exported-scene.bcf" || file name for "BIN" format
|-
|'''filesaver.directory''' || string || "luxcore-exported-scene" || output path for "TXT" format
|-
|'''filesaver.renderengine.type''' || string || "PATHCPU" || render engine to use when rendering the scene after it was saved with FILESAVER. Any engine string from above can be used here.
|}

===Experimental and debugging engines===

'''These engines are experimental, deprecated or are only intended for very specific purposes:'''

===="BIDIRVMCPU"====

Bidir with vertex merging, currently experimental. 
Supports the same settings as [[#"BIDIRCPU" | BIDIRCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''bidirvm.lightpath.count''' || int || 16 * 1024 || > 0 || || Number of lightpaths per pass
|-
|'''bidirvm.startradius.scale''' || float || 0.003 || > 0 || || Photon radius of the first pass
|-
|'''bidirvm.alpha''' || float || 3 || > 0 || [0.0, 1.0] || Photon radius is multiplied with this value after every pass to reduce the radius
|}

===="LIGHTCPU"====

For testing.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''light.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''light.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

==Sampler==

Samplers are used by following render engines:

* LIGHTCPU
* PATHCPU
* BIDIRCPU
* BIDIRVMCPU
* PATHOCL

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''sampler.type''' || string || "SOBOL" || sampler type
|}

The following samplers are available:

==="SOBOL"===

Sampler with sobol pattern.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.sobol.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==="METROPOLIS"===

Metropolis sampler.
Parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.metropolis.largesteprate''' || float || 0.4 || 0 ≤ x ≤ 1 || 0 - 1 || Probability of generating a large sample mutation
|-
|'''sampler.metropolis.maxconsecutivereject''' || int || 512 || x ≥ 0 || 0 - 32768 || Number of consecutive rejects before a next mutation is forced. Low values can cause bias
|-
|'''sampler.metropolis.imagemutationrate''' || float || 0.1 || 0 ≤ x ≤ 1 || 0 - 1 || Maximum distance over the image plane for a small mutation
|}

==="RANDOM"===

Fully random sampler. This sampler is mostly intended for testing purpose.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.random.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==Filter==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.type''' || string || "BLACKMANHARRIS" || || || Type of pixel filter.
|-
|'''film.filter.width''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Filter radius in pixels. Does not have an effect on the NONE filter
|-
|'''film.filter.xwidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|-
|'''film.filter.ywidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|}

Available filters are:

==="NONE"===

Disable pixel filtering.

==="BOX"===

Box pixel filter. No parameters.

==="GAUSSIAN"===

Gaussian pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.gaussian.alpha''' || float || 2.0 || x > 0.0 || 0.1 - 10.0 || Gaussian rate of falloff. Lower values give blurrier images.
|}

==="MITCHELL"===

Mitchel pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchell.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchell.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="MITCHELL_SS"===

Mitchel pixel filter with super-sampling (i.e. image will be filtered first with a grid of 4 pixels for each pixel).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchellss.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchellss.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="BLACKMANHARRIS"===

Blcakman-Harris pixel filter. No parameters.

==Light Strategy==

The direct light sampling strategy is defined by the following property:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.type''' || string || "LOG_POWER" || "UNIFORM", "POWER", "LOG_POWER" or "DLS_CACHE" || N/A || Direct light sampling strategy
|}

==="UNIFORM"===

"UNIFORM" light strategy samples evenly all light sources.

==="POWER"===

"POWER" light strategy samples the light sources based on their power.

==="LOG_POWER"===

"LOG_POWER" light strategy samples the light sources based on logarithm of their power.

==="DLS_CACHE"===

Build direct light sampling cache to optimize many-lights rendering, beneficial in scenes with multiple light sources with few overlap between their influence areas (e.g. a building with many disconnected rooms and interior lights).

Options for the DLS cache:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.entry.radius''' || float || 0.0 || || N/A || Entry radius in meters, automatic radius estimation is used if the radius is set to 0
|-
|'''lightstrategy.entry.normalangle''' || float || 25.0 || || N/A ||
|-
|'''lightstrategy.entry.maxpasses''' || int || 1024 || || N/A ||
|-
|'''lightstrategy.entry.convergencethreshold''' || float || 0.05 || || N/A ||
|-
|'''lightstrategy.entry.warmupsamples''' || int || 24 || || N/A ||
|-
|'''lightstrategy.targetcachehitratio''' || float || 0.995 || || N/A ||
|-
|'''lightstrategy.maxdepth''' || int || 4 || || N/A ||
|-
|'''lightstrategy.maxsamplescount''' || int || 10000000 || || N/A ||
|-
|'''lightstrategy.persistent.file''' || string || "" || || N/A ||
|-
|'''lightstrategy.persistent.safesave''' || bool || 1 || || N/A ||

|}

==Accelerator==

The ray/triangle intersection accelerator to use for the rendering is defined by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''accelerator.type''' || string || "AUTO" || "AUTO", "BVH", "MBVH", "EMBREE" || "AUTO" || The intersection accelerator. "AUTO" will select the best one available for the current [[LuxRays]] intersection device. "EMBREE" is currently usable only on CPU render engines
|-
|'''accelerator.instances.enable''' || bool || 1 || 0 or 1 || 0 or 1 || Enable instance support (or disable in order to slightly increase rendering speed)
|}

==Epsilon==

Minimum and maximum allowed value for scene epsilon can be define by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''scene.epsilon.min''' || float || 1e-5f || Any float value || 1e-6f ≤ x ≤ 1e-1f || Minimum allowed value for scene epsilon
|-
|'''scene.epsilon.max''' || float || 1e-1f || Any float value || 1e-3f ≤ x ≤ 1e+2f || Maximum allowed value for scene epsilon
|}

==Film==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.safesave''' || bool || 1 || enable "safe save" of Film serialization. A backup of the output is always valid even in the case of a system failure.
|}

===Film OpenCL Options===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.opencl.enable''' || bool || 1 || enable OpenCL film operations
|-
|'''film.opencl.platform''' || unsigned int || -1 || choose which platform will be used by the film operations. (0 is first platform, 1 second and so on. -1 for all)
|-
|'''film.opencl.device''' || unsigned int || -1 || choose which device will be used by the film operations. (0 is first device, 1 second and so on. -1 for first GPU device)
|}

===Film Outputs (aka AOVs)===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.safesave''' || bool || 1 || enable "safe save" for Film outputs. A backup of the output is always valid even in the case of a system failure
|}

The film object supports many types of outputs (aka AOVs). The complete list of supported output types:

{| class="wikitable" cellspacing="2"
!Name
!Type
|-
|'''RGB''' || HDR
|-
|'''RGBA''' || HDR
|-
|'''RGB_IMAGEPIPELINE''' || HDR/LDR
|-
|'''RGBA_IMAGEPIPELINE''' || HDR/LDR
|-
|'''ALPHA''' || HDR/LDR
|-
|'''DEPTH''' || HDR
|-
|'''POSITION''' || HDR
|-
|'''GEOMETRY_NORMAL''' || HDR
|-
|'''SHADING_NORMAL''' || HDR
|-
|'''MATERIAL_ID''' || LDR
|-
|'''DIRECT_DIFFUSE''' || HDR
|-
|'''DIRECT_GLOSSY''' || HDR
|-
|'''EMISSION''' || HDR
|-
|'''INDIRECT_DIFFUSE''' || HDR
|-
|'''INDIRECT_GLOSSY''' || HDR
|-
|'''INDIRECT_SPECULAR''' || HDR
|-
|'''MATERIAL_ID_MASK''' || HDR/LDR
|-
|'''DIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''INDIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''RADIANCE_GROUP''' || HDR/LDR
|-
|'''UV''' || HDR/LDR
|-
|'''RAYCOUNT''' || HDR/LDR
|-
|'''BY_MATERIAL_ID''' || HDR/LDR
|-
|'''IRRADIANCE''' || HDR
|-
|'''OBJECT_ID''' || LDR
|-
|'''OBJECT_ID_MASK''' || HDR/LDR
|-
|'''BY_OBJECT_ID''' || HDR/LDR
|-
|'''SAMPLECOUNT''' || HDR/LDR
|-
|'''CONVERGENCE''' || HDR/LDR
|-
|'''NOISE''' || HDR/LDR
|-
|'''SERIALIZED_FILM''' || N/A
|-
|'''MATERIAL_ID_COLOR''' || HDR/LDR
|}

Outputs are enabled with the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.<index>.type''' || string || || Type of output, e.g. "RGBA" or "ALPHA" (see the list above for the available types)
|-
|'''film.outputs.<index>.filename''' || string || || Filename to use when saving the output. The filename should use ".exr" as extension for HDR outputs and ".png" for LDR outputs (see list above for which output is HDR and which LDR)
|-
|'''film.outputs.<index>.id''' || int || || Specify for the following outputs: '''MATERIAL_ID_MASK''', '''RADIANCE_GROUP''', '''BY_MATERIAL_ID''', '''OBJECT_ID_MASK''', '''BY_OBJECT_ID''' (to choose the object ID, material ID or radiance group ID of the output)
|-
|'''film.outputs.<index>.index''' || int || || Specify for an imagepipeline output (RGB_IMAGEPIPELINE or RGBA_IMAGEPIPELINE) to select the imagepipeline of the output. For example, if you have 3 imagepipelines defined, and you want to specify the output of the third imagepipeline, use 2 for the ".index" property of the output
|}

Note that the Bidir engine does not support all AOVs.
Not supported by Bidir are: EMISSION, DIRECT_DIFFUSE, DIRECT_GLOSSY, INDIRECT_DIFFUSE, INDIRECT_GLOSSY, INDIRECT_SPECULAR, DIRECT_SHADOW_MASK, INDIRECT_SHADOW_MASK, IRRADIANCE, RAYCOUNT.

This is the list of output channel data types and sizes:

{| class="wikitable" cellspacing="2"
!Output type
!Data type
!Size
!Description
|-
|RGB||float||film width x film height x 3||R, G, B
|-
|RGB_IMAGEPIPELINE||float||film width x film height x 3||R, G, B
|-
|RGBA||float||film width x film height x 4||R, G, B, A
|-
|ALPHA||float||film width x film height x 1||Alpha value [0, 1]
|-
|DEPTH||float||film width x film height x 1||Camera distance
|-
|POSITION||float||film width x film height x 3||World X, Y, Z
|-
|GEOMETRY_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|SHADING_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|DIRECT_DIFFUSE||float||film width x film height x 3||Diffuse R, G, B
|-
|DIRECT_GLOSSY||float||film width x film height x 3||Glossy R, G, B
|-
|EMISSION||float||film width x film height x 3||Emission R, G, B
|-
|INDIRECT_DIFFUSE||float||film width x film height x 3||Indirect diffuse R, G, B
|-
|INDIRECT_GLOSSY||float||film width x film height x 3||Indirect glossy R, G, B
|-
|INDIRECT_SPECULAR||float||film width x film height x 3||Indirect specular R, G, B
|-
|MATERIAL_ID_MASK||float||film width x film height x 1||Material mask [0, 1]
|-
|DIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|INDIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|RADIANCE_GROUP||float||film width x film height x 3||R, G, B
|-
|UV||float||film width x film height x 2||Texture coordinates U, V
|-
|RAYCOUNT||float||film width x film height x 1||Ray count
|-
|BY_MATERIAL_ID||float||film width x film height x 3||By material ID
|-
|MATERIAL_ID||uint||film width x film height x 1||Material ID
|-
|IRRADIANCE||float||film width x film height x 3||R, G, B
|-
|OBJECT_ID_MASK||float||film width x film height x 1||Object mask [0, 1]
|-
|BY_OBJECT_ID||float||film width x film height x 3||By object ID
|-
|OBJECT_ID||uint||film width x film height x 1||Object ID
|-
|SAMPLECOUNT||uint||film width x film height x 1||Sample count
|-
|CONVERGENCE||float||film width x film height x 1||The distance of each pixel from the convergence threshold
|-
|NOISE||float||film width x film height x 1||The noise estimated for each pixel
|-
|SERIALIZED_FILM||N/A||N/A||The complete Film serialized in binary format
|-
|MATERIAL_ID_COLOR||float||film width x film height x 3||Material ID converted to colors (with anti-aliasing)
|}

===Film Channels===

Film channels are implicitly enabled by declaring film outputs (even if the output is never used). For instance, declaring a "RGBA" output will automatically enable "RADIANCE_PER_PIXEL_NORMALIZED" (and "RADIANCE_PER_SCREEN_NORMALIZED" for BIDIRCPU) and "ALPHA".
The supported channels are:

{| class="wikitable" cellspacing="2"
!Channel type
!Data type
!Size
!Last element is weight ?
!Note
|-
|CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED||float||film width x film height x 4||Yes||One for each radiance group. Eye paths radiance.
|-
|CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED||float||film width x film height x 3||No||One for each radiance group. Light paths radiance. Used only by LIGHTCPU and BIDIRCPU.
|-
|CHANNEL_ALPHA||float||film width x film height x 2||Yes||
|-
|CHANNEL_RGB_IMAGEPIPELINE||float||film width x film height x 3||No||
|-
|CHANNEL_DEPTH||float||film width x film height x 1||No||
|-
|CHANNEL_POSITION||float||film width x film height x 3||No||
|-
|CHANNEL_GEOMETRY_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_SHADING_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_MATERIAL_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_DIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_DIRECT_GLOSSY||float||film width x film height x 4||Yes||
|-
|CHANNEL_EMISSION||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_SPECULAR||float||film width x film height x 4||Yes||
|-
|CHANNEL_MATERIAL_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_DIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_INDIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_UV||float||film width x film height x 2||No||
|-
|CHANNEL_RAYCOUNT||float||film width x film height||No||
|-
|CHANNEL_BY_MATERIAL_ID||float||film width x film height x 4||Yes||
|-
|CHANNEL_IRRADIANCE||float||film width x film height x 4||Yes||
|-
|CHANNEL_OBJECT_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_OBJECT_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_BY_OBJECT_ID||float||film width x film height x 4||Yes||
|}

This is the list of channels enabled by each output:

{| class="wikitable" cellspacing="2"
!Output
!Enabled channels
|-
|'''RGB''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''RGB_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''ALPHA''' || ALPHA
|-
|'''DEPTH''' || DEPTH
|-
|'''POSITION''' || DEPTH, POSITION
|-
|'''GEOMETRY_NORMAL''' || DEPTH, GEOMETRY_NORMAL
|-
|'''SHADING_NORMAL''' || DEPTH, SHADING_NORMAL
|-
|'''MATERIAL_ID''' || DEPTH, MATERIAL_ID
|-
|'''DIRECT_DIFFUSE''' || DIRECT_DIFFUSE
|-
|'''DIRECT_GLOSSY''' || DIRECT_GLOSSY
|-
|'''EMISSION''' || EMISSION
|-
|'''INDIRECT_DIFFUSE''' || INDIRECT_DIFFUSE
|-
|'''INDIRECT_GLOSSY''' || INDIRECT_GLOSSY
|-
|'''INDIRECT_SPECULAR''' || INDIRECT_SPECULAR
|-
|'''MATERIAL_ID_MASK''' || MATERIAL_ID, MATERIAL_ID_MASK
|-
|'''DIRECT_SHADOW_MASK''' || DIRECT_SHADOW_MASK
|-
|'''INDIRECT_SHADOW_MASK''' || INDIRECT_SHADOW_MASK
|-
|'''RADIANCE_GROUP''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''UV''' || DEPTH, UV
|-
|'''RAYCOUNT''' || DEPTH, RAYCOUNT
|-
|'''BY_MATERIAL_ID''' || BY_MATERIAL_ID
|-
|'''IRRADIANCE''' || IRRADIANCE
|-
|'''OBJECT_ID''' || DEPTH, OBJECT_ID
|-
|'''OBJECT_ID_MASK''' || OBJECT_ID, OBJECT_ID_MASK
|-
|'''BY_OBJECT_ID''' || BY_OBJECT_ID
|}

Note: CHANNEL_RGB_IMAGEPIPELINE is always enable and the result of running the image pipeline.

===Image pipeline===

It is possible to define multiple image pipelines at the same time by using the '''film.imagepipelines.<pipeline #>.''' properties prefix. Each image pipeline takes as input the raw rendering and is a chain off image pipeline plugins. Each plugin receives previous plugin output and produces a new output.

====Radiance Group====

Radiance groups are used to get only the contribution of a group of lights in the scene. 
Lights can be grouped by setting their [[#Common_parameters | '''.id''']] property to the same number, on materials this is done with the [[#Light_emission | '''.emission.id''']] property. 

Note that the OpenCL engines only support up to 8 radiance groups (one of them is the default group).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.globalscale''' || float|| 1 || global weighting of radiance group
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.temperature ''' || float || 6500.0 || light temperature
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.rgbscale''' || vector || 1.0 1.0 1.0 || light color
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.radiancescales.<id>.enabled''' || bool || 1 || enable radiance group
|}

====Image pipeline plug-ins====

=====Type: TONEMAP_LINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || linear tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 1.0 || tonemapping scale
|}

=====Type: TONEMAP_REINHARD02=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_REINHARD02" || reinhard tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.prescale''' || float || 1.0 || reinhard prescale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.postscale''' || float || 1.2 || reinhard postscale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.burn''' || float || 3.75 || reinhard burn
|}

=====Type: TONEMAP_AUTOLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_AUTOLINEAR" || automatic linear tonemapping
|}

=====Type: TONEMAP_LUXLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LUXLINEAR" || linear tonemapping with real camera settings
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sensitivity''' || float || 100.0 || ISO sensitivity
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.exposure''' || float || 0.001 || exposure time
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.fstop''' || float || 2.8 || f/aperture
|}

=====Type: NOP=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipeline.<pipeline #>.<plugin #>.type''' || string || "NOP" || no parameters tonemapper
|}

=====Type: GAMMA_CORRECTION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || gamma correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.value''' || float || 2.2 || gamma value
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.table.size''' || unsigned int || 4096 || resolution
|}

=====Type: OUTPUT_SWITCHER=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OUTPUT_SWITCHER" || overwrite output
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.channel''' || string || "DEPTH" || channel whose values are used to overwrite
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.index''' || unsigned int || 0 || index
|}

=====Type: GAUSSIANFILTER_3x3=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "GAUSSIANFILTER_3x3" || gaussian filter
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.15 || blurring weight
|}

=====Type: CAMERA_RESPONSE_FUNC=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || CAMERA_RESPONSE_FUNC || analog camera film simulation
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.name''' || string || "Advantix_100CD" || film type
|}

=====Type: BACKGROUND_IMG=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || BACKGROUND_IMG || show the background image where alpha < 1 (simple compositing)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || ... || background image path (e.g scenes/simple-mat/sky.exr)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.gamma''' || float || 2.2 || background image gamma
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.storage ''' || string || auto || background image storage type
|}
Note: When the size of the background image differs from the film size, it will be stretched to fit the film size.

=====Type: BLOOM=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "BLOOM" || bloom effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.radius''' || float || 0.07 || how large the bloom effect is in % of the image size (i.e. 1.0 = all image)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.25 || how strong the effect is (i.e. 0.0 = nothing, 1.0 = max. strength)
|}

=====Type: VIGNETTING=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "VIGNETTING" || vignetting effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 0.4 || vignetting strength
|}

=====Type: COLOR_ABERRATION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_ABERRATION" || color aberration effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || color aberration amount
|}

=====Type: MIST=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "MIST" || aerial perspective effect (fake fog)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.color''' || spectrum|| [1, 1, 1] || mist color
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || mist amount
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.startdistance''' || float || 0 || distance from camera until where the mist effect has zero effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.enddistance''' || float || 10000 || distance from camera from where the mist effect has maximum effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.excludebackground''' || bool || false || Do not apply mist effect on pixels with infinite distance to the camera
|}

=====Type: CONTOUR_LINES=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "CONTOUR_LINES" || contour lines for IRRADIANCE AOV
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.range''' || float|| ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.steps''' || int || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.zerogridsize''' || int || ? || ?
|}

=====Type: WHITE_BALANCE =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "WHITE_BALANCE" || White temperature correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.temperature''' || unsigned int|| 6500 || Target image temperature in Kelvin
|-
|}

=====Type: COLOR_LUT =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_LUT" || Applies .cube LUT (look-up-table) to the input
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || "lut.cube" || Filepath to a [https://wwwimages2.adobe.com/content/dam/acom/en/products/speedgrade/cc/pdfs/cube-lut-specification-1.0.pdf .cube LUT file]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.strength''' || float || 1.0 || Linear interpolation between input (0.0) and output (1.0) of the plugin
|-
|}

=====Type: INTEL_OIDN =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "INTEL_OIDN" || Denoises the image using [https://github.com/OpenImageDenoise/oidn Intel OIDN]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.filter.type''' || string || "RT" ||
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.oidnmemory''' || int || 6000 || Approximate maximum amount of memory to use in megabytes (actual memory usage may be higher). Limiting memory usage may cause slower denoising due to internally splitting the image into overlapping tiles
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

=====Type: OPTIX_DENOISER =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OPTIX_DENOISER" || Denoises the image using the Nvidia OptiX denoiser
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.minspp''' || unsigned int || 0 || Minimum amount of samples to be rendered before the plugin is run (at lower sample numbers, it does not modify the input)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

===Film Subregion===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.subregion''' || vector || ... || <xstart> <xstop> <ystart> <ystop>
|}

===Rendering halt conditions===

By default, a LuxCore rendering will never stop however you can enable one or multiple halt conditions:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''batch.haltnoisethreshold''' || float || -1.0 || enable image convergence test and stops when the error is under the defined value. Use a value like "n / 256.0" where n is the level of error you are looking for. It may be hard to achieve a level of error smaller than 3.0 / 256.0. -1.0 disables the halt condition.
|-
|'''batch.haltnoisethreshold.warmup''' || unsigned int || 64 || number of average samples per pixel before to start the convergence test
|-
|'''batch.haltnoisethreshold.step''' || unsigned int || 64 || number of average samples per pixel between two tests
|-
|'''batch.haltnoisethreshold.filter.enable''' || bool || 1 || if the CONVERGENCE AOV (generated by the batch.haltnoisethreshold) should be filtered or not with a 3x3 box filter
|-
|'''batch.haltnoisethreshold.stoprendering.enable''' || bool || 1 || Set this to 0 (false) if you only want to use the haltnoisethreshold settings for adaptive sampling in an endless render
|-
|'''batch.haltnoisethreshold.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for stopping
|-
|'''batch.halttime''' || float || 0.0 || number of seconds before stopping the rendering
|-
|'''batch.haltspp''' || unsigned int || 0 || number of average samples per pixel before stopping the rendering
|}

===Noise estimation===

Image noise can be estimated and its result can be used to drive the Sobol and Random samplers to focus its sampling in the noisier regions.
Setting any of these properties will enable the noise estimation.
The adaptiveness strength is a Sampler property.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.noiseestimation.warmup''' || unsigned int || 32 || number of average samples per pixel before to start the convergence test
|-
|'''film.noiseestimation.step''' || unsigned int || 32 || number of average samples per pixel between two tests
|-
|'''film.noiseestimation.filter.scale''' || unsigned int || 4 || Box filter scale used to filter the NOISE AOV (generated by the noise estimation). Set to 0 to disable.
|-
|'''film.noiseestimation.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for adaptive sampling
|-
|}

=Scene file=

==Camera==

General parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.type''' || string || "perspective" || "perspective", "orthographic", "environment" (360° panorama mapped in latlong format) or "stereo"
|-
|'''scene.camera.lookat.orig''' || point (float float float) || 0.0 10.0 0.0 || camera location
|-
|'''scene.camera.lookat.target''' || point (float float float) || 0.0 0.0 0.0 || camera target
|-
|'''scene.camera.up''' || vector (float float float) || (0.0, 0.0, 1.0) || camera up vector
|-
|'''scene.camera.fieldofview''' || float || 45.0 || field of view
|-
|'''scene.camera.shutteropen''' || float || 0.0 || camera shutter open time (used for motion blur)
|-
|'''scene.camera.shutterclose''' || float || 0.0 || camera shutter close time (used for motion blur)
|-
|'''scene.camera.autovolume.enable''' || bool || true || try automatically to discover scene.camera.volume
|-
|'''scene.camera.volume''' || string || || the initial volume rays will travel in
|-
|'''scene.camera.cliphither''' || float || 1e-3 || TBD
|-
|'''scene.camera.clipyon''' || float || 1e30 || TBD
|-
|}

Parameters only applicable if scene.camera.type == "orthographic" or "perspective" or "environment"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.screenwindow''' || vector || 0.0 1.0 0.0 1.0 || <xstart> <xstop> <ystart> <ystop>
|-
|}

Parameters only applicable if scene.camera.type == "perspective"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.bokeh.distribution.type''' || string || NONE || "NONE", "UNIFORM", "EXPONENTIAL", "INVERSEEXPONENTIAL", "GAUSSIAN", "INVERSEGAUSSIAN", "TRIANGULAR", "CUSTOM"
|-
|'''scene.camera.bokeh.blades''' || int || 0 || Number of aperture blades
|-
|'''scene.camera.bokeh.power''' || int || 3 || Distribution factor, only for "EXPONENTIAL" and "INVERSEEXPONENTIAL" types
|-
|'''scene.camera.bokeh.distribution.image''' || string || "image.png" || only if type == "CUSTOM"
|-
|'''scene.camera.bokeh.scalex''' || double || 1.0 || TBD
|-
|'''scene.camera.bokeh.scaley''' || double || 1.0 || TBD
|-
|}

Parameters only applicable if scene.camera.type == "stereo"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.stereo.type''' || string || "perspective" || "perspective", "environment_180", "environment_360"
|-
|'''scene.camera.eyesdistance''' || 0.0626 || NONE || TBD
|-
|'''scene.camera.lensdistance''' || 0.2779 || NONE || TBD
|-
|}

Parameters only applicable if scene.camera.type == "perspective" or "stereo"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.oculusrift.barrelpostpro.enable''' || bool || false || TBD
|-
|}

Parameters only applicable if scene.camera.type == "environment"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.environment.degrees''' || double || 360.0 || TBD
|-
|}

Parameters only applicable if scene.camera.type != "environment"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.lensradius''' || double || 0.0 || TBD
|-
|'''scene.camera.focaldistance''' || double || 10.0 || TBD
|-
|'''scene.camera.autofocus.enable''' || bool || false || TBD
|-
|'''scene.camera.clippingplane.enable''' || bool || false || TBD
|-
|'''scene.camera.clippingplane.center''' || 0.0 0.0 0.0 || 360.0 || TBD
|-
|'''scene.camera.clippingplane.normal''' || 0.0 0.0 0.0 || 360.0 || TBD
|-
|}

The camera supports motion blur. See [[ LuxCore_SDL_Reference_Manual_v2.0#Object_Motion_Blur | Object Motion Blur ]]. 
(Only difference being that instead of the prefix '''scene.objects.<object name>''', the prefix '''scene.camera''' is used when setting motion properties of the camera)

==Textures==

Check [[LuxCoreRender_Textures|LuxCoreRender Textures]] for a high level description and examples of the textures.

===Mapping===

Some texture (mostly procedural textures) supports 2D or 3D mapping parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping2d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.rotation''' || float || 0.0 || UV rotation (in degrees)
|-
|'''scene.textures.<texture name>.mapping.uvscale''' || UV || 1.0 1.0 || UV scale
|-
|'''scene.textures.<texture name>.mapping.uvdelta''' || UV || 0.0 0.0 || UV translation
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "globalmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

===Type: add===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "add" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: subtract===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "subtract" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: band===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "band" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5|| texture name or constant
|-
|'''scene.textures.<texture name>.interpolation''' || string || "linear"|| "linear", "cubic" or "none"
|-
|'''scene.textures.<texture name>.offset[0..n]''' || float || 0.0 || multiple offsets in the range of [0.0, 1.0]
|-
|'''scene.textures.<texture name>.value[0..n]''' || spectrum || 1.0 1.0 1.0 || a value for each offset
|}

===Type: blender_blend===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_blend" || type of texture
|-
|'''scene.textures.<texture name>.progressiontype''' || string || "linear" || linear, quadratic, easing, diagonal, spherical, quadratic_spherical, halo or radial
|-
|'''scene.textures.<texture name>.direction''' || string || "horizontal" || horizontal or vertical
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_clouds===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_clouds" || type of texture
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || hard_noise or soft_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_distortednoise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_distortednoise" || type of texture
|-
|'''scene.textures.<texture name>.noise_distortion''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.distortion''' || float || 1 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_magic===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_magic" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_marble===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_marble" || type of texture
|-
|'''scene.textures.<texture name>.marbletype''' || string || "soft" || soft, sharp or sharper
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_musgrave===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_musgrave" || type of texture
|-
|'''scene.textures.<texture name>.musgravetype''' || string || "multifractal" || multifractal, ridged_multifractal, hybrid_multifractal, fBM or hetero_terrain
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.dimension''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.lacunarity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.offset''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.octaves''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_noise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_noise" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_stucci===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_stucci" || type of texture
|-
|'''scene.textures.<texture name>.stuccitype''' || string || "plastic" || plastic, wall_in or wall_out
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_wood===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || bands, rings, bandnoise or ringnoise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_voronoi===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_voronoi" || type of texture
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.distmetric''' || string || "actual_distance" || actual_distance, distance_squared, manhattan, chebychev, minkowski_half, minkowski_four or minkowski
|-
|'''scene.textures.<texture name>.w1''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.w2''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w3''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w4''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: brick===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "brick" || type of texture
|-
|'''scene.textures.<texture name>.bricktex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.mortartex''' || texture || 0.2 0.2 0.2 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodtex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodbias''' || float || 0.0 || With bias = -1, only the bricktex is used for the brick color. With bias between -1 and 1, a pseudo-random interpolation between bricktex and brickmodtex is used as brick color. With bias = 1, only the brickmodtex is used for the brick color.
|-
|'''scene.textures.<texture name>.brickbond''' || string || "running" || "flemish", "english", "herringbone", "basket" or "chain link"
|-
|'''scene.textures.<texture name>.brickwidth''' || float || 0.3 || brick width
|-
|'''scene.textures.<texture name>.brickheight''' || float || 0.1 || brick height
|-
|'''scene.textures.<texture name>.brickdepth''' || float || 0.15 || brick depth
|-
|'''scene.textures.<texture name>.mortarsize''' || float || 0.01 ||mortar size
|-
|'''scene.textures.<texture name>.brickrun''' || float || 0.75 || brick run
|}

This texture supports 3D mapping.

===Type: checkerboard3d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard3d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 3D mapping.

===Type: checkerboard2d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard2d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: constfloat1===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat1" || type of texture
|-
|'''scene.textures.<texture name>.value''' || float || 1.0 || constant value
|}

===Type: constfloat3===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat3" || type of texture
|-
|'''scene.textures.<texture name>.value''' || spectrum || (1.0, 1.0, 1.0) || RGB constant value
|}

===Type: densitygrid===

You can use ".data", ".data3" or ".openvdb.file" to define the 3D grid values.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "densitygrid" || type of texture
|-
|'''scene.textures.<texture name>.nx''' || unsigned int || || grid x size
|-
|'''scene.textures.<texture name>.ny''' || unsigned int || || grid y size
|-
|'''scene.textures.<texture name>.nz''' || unsigned int || || grid z size
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.storage''' || string || "half" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.data''' || float || || vector grid values (total count: nx * ny * nz)
|-
|'''scene.textures.<texture name>.data3''' || float || || vector grid values (total count: nx * ny * nz * 3)
|-
|'''scene.textures.<texture name>.openvdb.file''' || string || || OpenVDB file name
|-
|'''scene.textures.<texture name>.openvdb.grid''' || string || || OpenVDB grid name to read from the file
|}

===Type: dots===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dots" || type of texture
|-
|'''scene.textures.<texture name>.inside''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.outside''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: fbm===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fbm" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: fresnelapproxk===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxk" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: fresnelapproxn===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxn" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: hitpointalpha===

Use the value obtained by interpolating triangle vertices alphas.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointalpha" || type of texture
|}

===Type: hitpointcolor===

Use the color obtained by interpolating triangle vertices colors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointcolor" || type of texture
|}

===Type: hitpointgrey===

Use the value obtained by interpolating triangle vertices colors, mapped to a float value (RGB converted into greyscale).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointgrey" || type of texture
|-
|'''scene.textures.<texture name>.channel''' || int || -1 || the index of the RGB channel to use. -1 means the luminance of the RGB value
|}

===Type: hsv===

Hue saturation value manipulation.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hsv" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input color that will be manipulated
|-
|'''scene.textures.<texture name>.hue''' || texture || 0.5 || shift in hue (range: 0..1)
|-
|'''scene.textures.<texture name>.saturation''' || texture || 1.0 || saturation (range: 0..inf)
|-
|'''scene.textures.<texture name>.value''' || texture || 1.0 || brightness multiplier (range: 0..inf)
|}

===Type: imagemap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "imagemap" || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || "image.png" || name of the image file
|-
|'''scene.textures.<texture name>.gamma''' || float || 2.2 || gamma correction value used in the image
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 || image values are multiplied by gain value
|-
|'''scene.textures.<texture name>.storage''' || string || "auto" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of image map wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.channel''' || string || "default" || extract from the image only the selected channels: "default", "red", "green", "blue", "alpha", "mean", "colored_mean", "rgb"
|}

===Type: normalmap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "normalmap" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input. Is treated as an XYZ vector in tangent space.
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || multiplier for adjusting normalmap height
|}

===Type: marble===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "marble" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || marble scale
|-
|'''scene.textures.<texture name>.variation''' || float || 0.2 || marble variation
|}

This texture supports 3D mapping.

===Type: mix===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "mix" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.texture1''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: scale===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "scale" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: uv===

This procedural texture has no parameters aside from the support of 2D mapping.

===Type: windy===

This procedural texture has no parameters aside from the support of 3D mapping.

===Type: wood===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || "bands", "rings", "bandnoise" or "ringnoise"
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || "sin", "saw" or "tri"
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || "soft_noise" or "hard_noise"
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 || noise size
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 || noise turbulence
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 || bright
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 || contrast
|}

This texture supports 3D mapping.

===Type: wrinkled===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wrinkled" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: abs===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "abs" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|}

===Type: clamp===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "clamp" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.min''' || float || 0.0 || lower boundary of the clamping
|-
|'''scene.textures.<texture name>.max''' || float || 1.0 || upper boundary of the clamping
|}

===Type: divide===

Note: If texture2 (the divisor) is 0, 0 is returned.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "divide" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant (dividend)
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant (divisor)
|}

===Type: remap===

This texture brings the value from the source range into the target range.

Note: The value is clamped into source range before performing the remap operation, and the resulting number is also clamped into the target range.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "remap" || type of texture
|-
|'''scene.textures.<texture name>.value''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemax''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmax''' || texture || 1.0 || texture name or constant
|}

===Type: objectid===

Raw object ID (range 0 to 0xfffffffe).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectid" || type of texture
|}

===Type: objectidcolor===

Object ID interpreted as color. 
The object ID is a 4 byte unsigned int. To convert to color, the lower three bytes are interpreted as r, g, b values (each range 0 to 255). The highest byte is ignored.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidcolor" || type of texture
|}

===Type: objectidnormalized===

Normalized object ID (range 0 to 1).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidnormalized" || type of texture
|}

===Type: dotproduct ===

Dot product of the two input vectors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dotproduct" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: power ===

pow(base, exponent)

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "power" || type of texture
|-
|'''scene.textures.<texture name>.base''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.exponent''' || texture || 1.0 || texture name or constant
|}

===Type: lessthan ===

returns 1 if texture1 < texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lessthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: greaterthan ===

returns 1 if texture1 > texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "greaterthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: shadingnormal ===

Returns the shading normal of the mesh at the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "shadingnormal" || type of texture
|}

===Type: position ===

Returns the position of the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "position" || type of texture
|}

===Type: splitfloat3 ===

Extract a channel from a float3 texture. Can for example be used to get the R, G or B channel of a color texture, or to get the X, Y or Z components of a vector texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "splitfloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.channel''' || int || 0 || the channel to get from the input texture. 0 for first channel, 1 for second, 2 for third channel
|}

===Type: makefloat3 ===

Combine three float textures into one float3 texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "makefloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture3''' || texture || 1.0 || texture name or constant
|}

===Type: blackbody===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blackbody" || type of texture
|-
|'''scene.textures.<texture name>.temperature''' || float || 6500 || emission temperature
|-
|'''scene.textures.<texture name>.normalize''' || bool || false || normalize the output
|}

===Type: irregulardata===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "irregulardata" || type of texture
|-
|'''scene.textures.<texture name>.wavelengths''' || vector || 580.0 620.0 660.0|| wavelenghts
|-
|'''scene.textures.<texture name>.data''' || vector || 0.0 0.000015 0.0|| data (length should match wavelength's length)
|}

===Type: lampspectrum===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lampspectrum" || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || "Daylight" || lamp light spectrum
|}

===Type: Fresnel Textures===

Textures for loading optical data

====Type: fresnelcolor====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelcolor || type of texture
|-
|'''scene.textures.<texture name>.kr''' || vector || 0.5 0.0 0.0 || reflection color
|}

====Type: fresnelpreset====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || aluminium || fresnel preset ("aluminium", "silver", "copper", "gold" or "amorphous carbon")
|}

====Type: fresnelsopra====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Au.nk)
|}

====Type: fresnelluxpop====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Cr.nk)
|}

====Type: distort====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || distort || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0.0 || texture name or constant; input texture
|-
|'''scene.textures.<texture name>.offset''' || texture || 0.0 || texture name or constant; offset to add to the hitpoint coordinates and UV values before evaluating the input texture
|-
|'''scene.textures.<texture name>.strength''' || float || 1.0 || strength multiplier, is multiplied with the offset
|}

==Volumes==

Check [[LuxCoreRender_Volumes|LuxCoreRender Volumes]] for a high level description and examples of the volumes.

All volumes share these properties

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|-
|'''scene.volumes.<volume name>.priority''' || unsigned int|| 0|| volume priority (when volumes overlap, the one with highest priority overrides the others)
|-
|'''scene.volumes.<volume name>.ior''' || texture|| ... || index of refraction
|-
|'''scene.volumes.<volume name>.absorption''' || texture || ... || absorption texture
|-
|'''scene.volumes.<volume name>.emission ''' || texture || ... || emission
|-
|'''scene.volumes.<volume name>.emission.id ''' || unsigned int || ... || emission ID
|}

===Volume: Clear===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|}

===Volume: Homogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || homogeneous|| volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|}

===Volume: Heterogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || heterogeneous || volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|-
|'''scene.volumes.<volume name>.steps.size''' || float || ... || step size
|-
|'''scene.volumes.<volume name>.steps.maxcount''' || unsigned int || ... || step maximum count
|}

==Materials==

Check [[LuxCoreRender_Materials|LuxCoreRender Materials]] for a high level description and examples of the materials.

===Common properties===

Common material properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.bumptex''' || texture || || texture to use for the bump mapping
|-
|'''scene.materials.<material name>.normaltex''' || texture || || texture to use for the normal mapping
|-
|'''scene.materials.<material name>.samples''' || int || -1 || number of rays used to sample this material. -1 means use the default global value. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.diffuse.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.glossy.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.specular.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.bumpsamplingdistance''' || float || 0.001 || set the offset used to sample bump/normal mapping.
|-
|'''scene.materials.<material name>.volume.interior''' || string || vol1 || name of interior volume (for volume rendering)
|-
|'''scene.materials.<material name>.volume.exterior''' || string || vol2 || name of exterior volume (for volume rendering)
|-
|'''scene.materials.<material name>.id''' || int|| ... || material id
|-
|'''scene.materials.<material name>.transparency''' || texture || 1.0 || transparency of the material. 1 for opaque, 0 for fully transparent
|-
|'''scene.materials.<material name>.shadowcatcher.enable''' || bool || false || If true, the material will be transparent where hit by direct light and opaque otherwise (alpha transparency). Used for compositing.
|}

====Normal maps====
Normal maps are set first as a texture type and then assigned to the material. For example:

<blockquote><pre>
scene.textures.normmap.type = imagemap
scene.textures.normmap.file = scenes/bump/normal.png
scene.textures.normmap.gamma = 1

scene.materials.mat_white.type = matte
scene.materials.mat_white.kd = 0.8 0.8 0.8
scene.materials.mat_white.normaltex = normmap
</pre></blockquote>

====Light emission====

All materials can emit light:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.emission''' || texture || 0.0 0.0 0.0 || color of the emitted light
|-
|'''scene.materials.<material name>.emission.gain''' || spectrum || 1.0 1.0 1.0 || multiplier for lamp brigthness
|-
|'''scene.materials.<material name>.emission.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.materials.<material name>.emission.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.materials.<material name>.emission.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light
|-
|'''scene.materials.<material name>.emission.iesblob''' || blob || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.materials.<material name>.emission.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.materials.<material name>.emission.samples''' || int || -1 || the number of shadow ray to trace to compute direct light from this material. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.materials.<material name>.emission.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.
|-
|'''scene.materials.<material name>.emission.theta''' || float || 90.0 || How directional the light is emitted, set as the half-angle of the light source. Default is 90°. Smaller values mean that more light is emitted in the direction of the face normals and less to the sides.
|-
|'''scene.materials.<material name>.emission.importance''' || float || 1.0 || A hint how often to sample this light source compared to other lights
|}

===Type: archglass===

This material should be used to replace glass material of windows when rendering architectural interiors. It allows direct light to pass trough.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "archglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: carpaint===

Car Paint is an advanced glossy material, simulating a diffuse surface with mutliple reflective coatings.

The available presets for the carpaint material are:

*"ford f8"
*"polaris silber"
*"opel titan"
*"bmw339"
*"2k acrylack"
*"white"
*"blue"
*"blue matte"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "carpaint" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "ford f8" || one of the avilable presets
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || absorption color
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || absorption depth
|-
|'''scene.materials.<material name>.kd''' || texture || 0.0 0.0 0.0 || diffuse color
|-
|'''scene.materials.<material name>.ks1''' || texture || 0.0 0.0 0.0 || specular color - layer 1
|-
|'''scene.materials.<material name>.ks2''' || texture || 0.0 0.0 0.0 || specular color - layer 2
|-
|'''scene.materials.<material name>.ks3''' || texture || 0.0 0.0 0.0 || specular color - layer 3
|-
|'''scene.materials.<material name>.r1''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 1
|-
|'''scene.materials.<material name>.r2''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 2
|-
|'''scene.materials.<material name>.r3''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 3
|-
|'''scene.materials.<material name>.m1''' || texture || 0.0 0.0 0.0 || roughness - layer 1
|-
|'''scene.materials.<material name>.m2''' || texture || 0.0 0.0 0.0 || roughness - layer 2
|-
|'''scene.materials.<material name>.m3''' || texture || 0.0 0.0 0.0 || roughness - layer 3
|}

===Type: cloth===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "cloth" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "denim" || denim, silk_charmeuse, silk_shantung, cotton_twill, wool_garbardine or polyester_lining_cloth
|-
|'''scene.materials.<material name>.weft_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in one weave direction
|-
|'''scene.materials.<material name>.weft_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in one weave direction
|-
|'''scene.materials.<material name>.warp_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.warp_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.repeat_u''' || float || 100.0 || thread count in the u direction
|-
|'''scene.materials.<material name>.repeat_v''' || float || 100.0 || thread count in the v direction
|}

===Type: disney===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "disney" || type of material
|-
|'''scene.materials.<material name>.basecolor''' || texture || 0.5 0.5 0.5 || Base color
|-
|'''scene.materials.<material name>.subsurface''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.roughness''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.metallic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.specular''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.speculartint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoat''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoatgloss''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.anisotropic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheen''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheentint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.filmamount''' || texture || none || Linear interpolation between no film (0) and full film effect (1) for artistic control. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.cauchyb''' || texture || 0.0 || if defined and > 0.0, enable dispersion. The value is the B term of the [https://en.wikipedia.org/wiki/Cauchy%27s_equation Cauchy's equation]
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glossy2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossy2" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossytranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossytranslucent" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmission color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.ks_bf''' || texture || 0.5 0.5 0.5 || texture or constant backface specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.uroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.vroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.ka_bf''' || texture || 0.0 0.0 0.0 || texture or constant value of backface coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.d_bf''' || texture || 0.0 || texture or constant value of the backface depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.index_bf''' || texture || 0.0 0.0 0.0 || IOR of the backface coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|-
|'''scene.materials.<material name>.multibounce_bf''' || bool || false || backface simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossycoating===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossycoating" || type of material
|-
|'''scene.materials.<material name>.base''' || string || || name of base material, the coating layer is added on top of this material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: matte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "matte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the matte material
|}

===Type: mattetranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mattetranslucent" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 0.5 0.5 0.5 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmitted color of the material
|}

===Type: metal2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "metal2" || type of material
|-
|'''scene.materials.<material name>.fresnel''' || fresnel texture || ... || [[#Type:_Fresnel_Textures | fresnel texture]]
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.preset''' || string || "aluminium" || (DEPRECATED) "aluminium", "silver", "copper", "gold" or "amorphous carbon"
|-
|'''scene.materials.<material name>.n''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxn texture on overwrite the .preset property
|-
|'''scene.materials.<material name>.k''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxk texture on overwrite the .preset property
|}

===Type: mirror===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mirror" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|}

===Type: mix===

This material can be used to mix 2 other materials.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mix" || type of material
|-
|'''scene.materials.<material name>.material1''' || string || mat1 || name of another material
|-
|'''scene.materials.<material name>.material2''' || string || mat2 || name of another material
|-
|'''scene.materials.<material name>.amount''' || texture || 0.5 || texture or constant value used to mix the materials
|}

===Type: null===

This is empty, not visible material. It can be combined by using mix material with others. It is often used in combination with the alpha channel of an image map to render leafs, etc.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "null" || type of material
|}

===Type: roughglass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: roughmatte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughmatte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the roughmatte material
|-
|'''scene.materials.<material name>.sigma''' || texture || 0.0 || the sigma parameter in the Oren-Nayer shader in degrees. Zero for pure Lambertian reflection
|}

===Type: velvet===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "velvet" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || color of the material's fuzz
|-
|'''scene.materials.<material name>.p1''' || texture || -2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p2''' || texture || 20.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p3''' || texture || 2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.thickness''' || texture || 0.1 || height of the fuzz
|}

==Objects==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.material''' || string || || type of object material
|-
|'''scene.objects.<object name>.shape''' || string || || name of [[#Shapes | shape]] with the triangle mesh description.Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same shape, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.ply''' || string || || '''(Deprecated, use .shape instead)''' name of [http://en.wikipedia.org/wiki/PLY_(file_format) PLY] file with the triangle mesh description. Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same file, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.objects.<object name>.vertices''' || float || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of float values defining the vertices of the mesh (i.e. 3 coordinates for each vertex).
|-
|'''scene.objects.<object name>.faces''' || unsigned int || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of unsigned int values defining the triangles of the mesh (i.e. 3 index of vertices for each triangle).
|-
|'''scene.objects.<object name>.id''' || unsigned int || || object ID
|-
|'''scene.objects.<object name>.camerainvisible''' || bool || false || toggle visibility for camera rays. If set to true, the object will not show up in camera rays, but it will still be visible in reflections, refractions, shadows, indirect light etc.
|}

===Object Motion Blur===

LuxCore supports transformation motion blur for objects.
Motion blur is enabled if an object has a motion system defined as described below.

A motion system consists of steps (at least 2). Each step has a time (in seconds) and a transformation matrix of the object at this point in time.
Step indices start at 0. The times have to be monotonic (each greater than the last).

Note that the embree accelerator only supports a maximum of 129 time steps.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.motion.<step>.time''' || float || || time (in seconds) of the step
|-
|'''scene.objects.<object name>.motion.<step>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix of the object at the given step
|-
|}

==Shapes==

===Type: mesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "mesh" || mesh shape
|-
|'''scene.shapes.<shape name>.ply''' || string || ... || mesh path (e.g ''scenes/luxball/luxball-shell.ply'')
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: inlinedmesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "inlinedmesh" || inlinedmesh shape
|-
|'''scene.shapes.<shape name>.vertices''' || vector || ... || inlinedmesh vertices (e.g 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0 0.0)
|-
|'''scene.shapes.<shape name>.faces''' || vector || ... || inlinedmesh faces (e.g 0 1 2)
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: pointiness===

Contains surface curvature information in vertex alpha channel. 
You can access this information in materials via a hitpointalpha texture. 
The values range from -1 to 1 (float). 
Values from -1 to 0 are concave, while values from 0 to 1 are convex.

[[ Shape:_Pointiness | Examples ]]

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "pointiness" || pointiness shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || pointiness source (a mesh shape)
|}

===Type: strands===

Can be used for hair, fur, grass etc. 
Note that you need to define the camera before defining any strands shapes, because the tesselation process is viewpoint-dependent.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "strands" || strands shape
|-
|'''scene.shapes.<shape name>.file''' || string || ... || strands file (''scenes/strands/straight.hair'')
|}

====Strands tessellation methods====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbon" || ribbon tessellation
|-
|'''scene.shapes.<shape name>.tessellation.usecameraposition''' || bool || 1 || use camera position
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbonadaptive" || ribbon adaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.maxdepth''' || unsigned int || 12 || max tessellation depth
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.error ''' || float || 0.0075 || max tessellation error
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solid" || solid tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solid.sidecount ''' || unsigned int || 12 || tessellation's side count
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solidadaptive" || solidadaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.sidecount ''' || unsigned int || 8 || tessellation's side count
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.maxdepth''' || unsigned int || 16 || tessellation's max depth
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.error''' || float || 0.05 || tessellation's max error
|}

===Type: group===

Todo.

===Type: displacement===

Todo.

===Type: subdiv===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "subdiv" || subdivided shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || source mesh name
|-
|'''scene.shapes.<shape name>.maxlevel''' || unsigned integer || 2 || maximum level of subdivision
|-
|'''scene.shapes.<shape name>.maxedgescreensize''' || float || 0.0 || maximum edge screen size
|-
|'''scene.shapes.<shape name>.adaptive''' || bool || 1 || Adaptive refinement / Uniform refinement
|}

===Type: harlequin===

Todo.

===Type: simplify===

Todo.

===Type: islandaov===

Todo.

===Type: randomtriangleaov===

Todo.

==Light sources==

Check [[Lighting|LuxCoreRender Lighting]] for an high level description and example of the light sources.

===Common parameters===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.gain''' || spectrum || 1.0 1.0 1.0 || intensity of the light
|-
|'''scene.lights.<light name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.lights.<light name>.samples''' || int || -1 || the number of shadow ray to trace to compute direct light for this light source. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.

|-
|'''scene.lights.<light name>.importance''' || float || 1.0 || A hint how often to sample this light compared to other lights
|}

===Type: sun===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sun" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.relsize''' || float || 1.0 || relative size to the sun
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sky2===

Hosek-Wilkie sky model.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sky2" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.gain''' || vector || ... || gain
|-
|'''scene.lights.<light name>.groundalbedo''' || vector || 0.5 0.5 0.5 || ground albedo
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.ground.enable''' || bool || 1 || enable ground color
|-
|'''scene.lights.<light name>.ground.color''' || vector|| ... || RGB ground color
|}

===Type: infinite===

Spherical lightsource surrounding the scene at infinite distance. 
Used for image based lighting (IBL) and HDR environment lighting if the file is a high dynamic range image.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "infinite" || type of light
|-
|'''scene.lights.<light name>.file''' || string || "image.png" || filename of the environment map
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma correction used by the image map
|-
|'''scene.lights.<light name>.storage''' || string || "auto" || environment map storage type ("auto", "byte", "half" or "float")
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.sampleupperhemisphereonly''' || bool || false || an option set to black the lower hemisphere. Mostly useful for shadow catchers.
|}

===Type: point===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "point" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mappoint===

Point light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mappoint" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: sphere===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mapsphere===

Sphere light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mapsphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: spot===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "spot" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.coneangle''' || float || 30.0 || angle in degrees of the spotlight cone
|-
|'''scene.lights.<light name>.conedeltaangle''' || float || 5.0 || angle at which the spotlight intensity starts to fade from the edge
|}

===Type: projection===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "projection" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.fov''' || float || 45.0 || field of view in terms of angular spread along the shorter image axis
|-
|'''scene.lights.<light name>.mapfile''' || string || || filename of the image to project. If not specified, a constat light color will be used.
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|}

===Type: constantinfinite===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "constantinfinite" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sharpdistant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sharpdistant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|}

===Type: distant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "distant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|-
|'''scene.lights.<light name>.theta''' || float || 10.0 || half angle of the light source in degree. Must be > 0 for soft shadows
|}

===Type: laser===

A light source emitting parallel light rays (like sharpdistant light, but starting inside the scene instead of infinitely far away).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "laser" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.radius''' || float || 0.01 || radius of the laser beam
|}

LuxCore SDL Reference Manual v2.11

2026-06-06T14:51:43Z

CodeHD: /* Camera */

The scene description language (SDL) is used to configure the renderer and to define objects, materials, textures etc. in the scene. 
The file ending of the render configuration file is ".cfg", for the scene file it's ".scn".

These files are usually created by exporter plugins, e.g. BlendLuxCore. 
This wiki page is primarily a reference for exporter developers, normal end-users should not need to edit cfg/scn files by hand.

Sometimes the API is updated faster than the wiki, in this case you can look at the code directly: https://github.com/LuxCoreRender/LuxCore/tree/master/src/slg/scene

Note that matrices are passed as flat lists in column-major form.

=Render configuration file=

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''resumerendering.filesafe''' || bool || 1 || enable/disable "safe save" mode for resume rendering file. A backup of the output is always valid even in the case of a system failure
|}

==Seed==

The global seed value that is used to generate random numbers. 
Two images rendered with the same seed will have the same noise pattern.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.seed''' || unsigned int || 1 || min 1
|}

==Periodic save==

Options related to periodic save operations.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''periodicsave.resumerendering.period''' || float || 0 || save the resume rendering file every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.resumerendering.filename''' || string || "resume.rsm" || the name to use to save the rendering resume information periodically
|-
|'''periodicsave.film.period''' || float || 0 || save the Film every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|-
|'''periodicsave.film.filename''' || string || "film.flm" || the name to use to save the film periodically
|-
|'''periodicsave.film.outputs.period''' || float || 600 || save all Film outputs every specified amount of time (value in seconds). A value <= 0.0 disable the saving
|}

==Render Engine==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''renderengine.type''' || string || "PATHCPU" || engine type
|}

=== CPU Render Engines ===

CPU render engines are written in C++ and don't require OpenCL. All CPU render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''native.threads.count''' || int || CPU core count || > 0 || > 0 || The number of threads will be used for the rendering
|}

'''The following CPU engines are available:'''

===="PATHCPU"====

A path tracer with full image plane rendering (i.e. supporting Metropolis sampler).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|}

===="TILEPATHCPU"====
Biased path tracer with many control options and support for tile rendering. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.pathdepth.total''' || int || 6 || > 0 || [1, 16] || Maximum recursion depth of a path
|-
|'''path.pathdepth.diffuse''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.glossy''' || int || 4 || > 0 || [1, 16] ||
|-
|'''path.pathdepth.specular''' || int || 6 || > 0 || [1, 16] ||
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette stars to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|-
|'''path.clamping.variance.maxvalue''' || float || 0.0 || > 0.0 || > 0.0 || Samples brighter than this value are clamped, helps to reduce fireflies. 0.0 = disabled
|-
|'''path.forceblackbackground.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable when rendering with transparent film and premultiplied alpha, to avoid artifacts with semi-transparent areas
|-
|'''tilepath.sampling.aa.size''' || int || 3 || > 0 || [1, 13] || All diffuse/glossy/specular samples are multiplied with the squared aa size: final_samples = aa^2 * (diffuse^2 + glossy^2 + specular^2)
|-
|'''tile.size''' || int || 32 || ≥ 8 || [8, 256] || Tile size in pixels
|-
|'''tile.multipass.enable''' || bool || 1 || 0 or 1 || o or 1 || Re-render the image until a halt threshold is met or indefinitely
|-
|'''tile.multipass.convergencetest.threshold''' || float || 6.0 / 256.0 || > 0.0 || [1.0 / 256.0, 6.0 / 256.0] || Target noise level
|-
|'''tile.multipass.convergencetest.threshold.reduction''' || float || 0.0 || [0.0, 1.0] || [0.75, 0.95] || Multiply noise level with this number when all tiles have met the previous noise level. Set to 0 to disable (so rendering will stop at the noise level)
|-
|'''tile.multipass.convergencetest.warmup.count''' || int || 32 || ≥ 0 || [8, 128] || Warm up period for the convergence test expressed in samples per pixel
|}

===="BIDIRCPU"====

A Bidirectional path tracer.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''path.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a eye path
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''path.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''path.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

===="RTPATHCPU"====
Engine optimized for interactive scene editing and camera movement. 
The sampler must be set to RTPATHCPUSAMPLER when using this engine.

Supports the same properties as [[#"PATHCPU" | "PATHCPU"]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpathcpu.zoomphase.size''' || int || 4 || || || render scaled down film for the first few frames after a scene edit (to make interactions more fluid)
|-
|'''rtpathcpu.zoomphase.weight''' || float || 0.1 || || || description: TODO
|}

=== OpenCL Render Engines ===

OpenCL engines can run on GPUs, CPUs and other types of computing devices, they require OpenCL to run. All OpenCL render engines accept the following parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''opencl.platform.index''' || int || -1 || A valid platform index || -1 || Select the OpenCL platform to use. All devices available on all platforms will be used with -1
|-
|'''opencl.cpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL CPU devices available
|-
|'''opencl.gpu.use''' || bool || 1 || 0 or 1 || 0 or 1 || If to use all OpenCL GPU devices available
|-
|'''opencl.cpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.gpu.workgroup.size''' || int || 0 || Any valid OpenCL workgroup size || 64 || Set the OpenCL workgroup size, 0 means to use the driver suggested value
|-
|'''opencl.devices.select''' || string || "" || Any valid selection string || Any valid selection string || Select each OpenCL device to use. It is a string of "0" and "1". "1" means use the device, "0" do not
|}

'''The following OpenCL engines are available:'''

===="PATHOCL"====
OpenCL version of PATHCPU. Supports the same settings as [[#"PATHCPU" | PATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''pathocl.pixelatomics.enable''' || bool || 0 || 0 or 1 || 0 or 1 || Enable pixel atomic operation
|-
|'''opencl.task.count''' || int || "AUTO" || "AUTO" or > 0 || [64K, 1024K] || The number of tasks sent to the OpenCL device in one kernel call
|}

===="RTPATHOCL"====

A PATHOCL version optimized for real-time rendering with fixed frame-rate and variable quality. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"PATHOCL" | PATHOCL]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''rtpath.resolutionreduction.preview''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels in the first passes. For instance 4x4 than 2x2 and than always 1x1
|-
|'''rtpath.resolutionreduction.preview.step''' || int || 8 || > 0 || [1, 32] || Each preview step is rendered for n frames
|-
|'''rtpath.resolutionreduction''' || int || 4 || > 0 || [1, 32] || Render a sample every n x n pixels, outside the preview phase, in order to reduce the per frame rendering time
|}

===="TILEPATHOCL"====

OpenCL version of TILEPATHCPU. 
The sampler must be set to TILEPATHSAMPLER when using this engine.

Supports the same settings as [[#"TILEPATHCPU" | TILEPATHCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''tilepathocl.devices.maxtiles''' || int || 16 || ≥ 1 || [1, 32] || Maximum number of tiles to send in a single call to each OpenCL device
|}

==="FILESAVER"===

Saves everything needed to render the scene to the output path, including textures and meshes.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''filesaver.format''' || string || "TXT" || "TXT" for a text SDL format and "BIN" for a single file binary format
|-
|'''filesaver.filename''' || string || "luxcore-exported-scene.bcf" || file name for "BIN" format
|-
|'''filesaver.directory''' || string || "luxcore-exported-scene" || output path for "TXT" format
|-
|'''filesaver.renderengine.type''' || string || "PATHCPU" || render engine to use when rendering the scene after it was saved with FILESAVER. Any engine string from above can be used here.
|}

===Experimental and debugging engines===

'''These engines are experimental, deprecated or are only intended for very specific purposes:'''

===="BIDIRVMCPU"====

Bidir with vertex merging, currently experimental. 
Supports the same settings as [[#"BIDIRCPU" | BIDIRCPU]] plus the following:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''bidirvm.lightpath.count''' || int || 16 * 1024 || > 0 || || Number of lightpaths per pass
|-
|'''bidirvm.startradius.scale''' || float || 0.003 || > 0 || || Photon radius of the first pass
|-
|'''bidirvm.alpha''' || float || 3 || > 0 || [0.0, 1.0] || Photon radius is multiplied with this value after every pass to reduce the radius
|}

===="LIGHTCPU"====

For testing.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''light.maxdepth''' || int || 5 || > 0 || [1, 16] || Maximum recursion depth of a light path
|-
|'''light.russianroulette.depth''' || int || 3 || > 0 || [1, path.maxdepth] || The path depth where Russian Roulette starts to be used
|-
|'''light.russianroulette.cap''' || float || 0.5 || [0.0, 1.0] || [0.0, 1.0] || The threshold over which Russian Roulette is used
|}

==Sampler==

Samplers are used by following render engines:

* LIGHTCPU
* PATHCPU
* BIDIRCPU
* BIDIRVMCPU
* PATHOCL

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''sampler.type''' || string || "SOBOL" || sampler type
|}

The following samplers are available:

==="SOBOL"===

Sampler with sobol pattern.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.sobol.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==="METROPOLIS"===

Metropolis sampler.
Parameters:
{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.metropolis.largesteprate''' || float || 0.4 || 0 ≤ x ≤ 1 || 0 - 1 || Probability of generating a large sample mutation
|-
|'''sampler.metropolis.maxconsecutivereject''' || int || 512 || x ≥ 0 || 0 - 32768 || Number of consecutive rejects before a next mutation is forced. Low values can cause bias
|-
|'''sampler.metropolis.imagemutationrate''' || float || 0.1 || 0 ≤ x ≤ 1 || 0 - 1 || Maximum distance over the image plane for a small mutation
|}

==="RANDOM"===

Fully random sampler. This sampler is mostly intended for testing purpose.
Parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''sampler.random.adaptive.strength''' || float || 0.7 || 0 ≤ x < 0.95 || 0.5 - 0.9 || it sets if the sampler should be more or less adaptive
|}

==Filter==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.type''' || string || "BLACKMANHARRIS" || || || Type of pixel filter.
|-
|'''film.filter.width''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Filter radius in pixels. Does not have an effect on the NONE filter
|-
|'''film.filter.xwidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|-
|'''film.filter.ywidth''' || float || 2.0 || x > 0.0 || 0.1 - 3.0 || Width in pixels. Overwrite '''film.filter.width''' value
|}

Available filters are:

==="NONE"===

Disable pixel filtering.

==="BOX"===

Box pixel filter. No parameters.

==="GAUSSIAN"===

Gaussian pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''film.filter.gaussian.alpha''' || float || 2.0 || x > 0.0 || 0.1 - 10.0 || Gaussian rate of falloff. Lower values give blurrier images.
|}

==="MITCHELL"===

Mitchel pixel filter.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchell.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchell.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="MITCHELL_SS"===

Mitchel pixel filter with super-sampling (i.e. image will be filtered first with a grid of 4 pixels for each pixel).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
| '''film.filter.mitchellss.b''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || B parameter for the mitchell filter in the range
|-
| '''film.filter.mitchellss.c''' || float || 1.0/3.0 || 0.0 ≤ x ≤ 1.0 || 0.0 - 1.0 || C parameter for the mitchell filter in the range 0..1
|}

==="BLACKMANHARRIS"===

Blcakman-Harris pixel filter. No parameters.

==Light Strategy==

The direct light sampling strategy is defined by the following property:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.type''' || string || "LOG_POWER" || "UNIFORM", "POWER", "LOG_POWER" or "DLS_CACHE" || N/A || Direct light sampling strategy
|}

==="UNIFORM"===

"UNIFORM" light strategy samples evenly all light sources.

==="POWER"===

"POWER" light strategy samples the light sources based on their power.

==="LOG_POWER"===

"LOG_POWER" light strategy samples the light sources based on logarithm of their power.

==="DLS_CACHE"===

Build direct light sampling cache to optimize many-lights rendering, beneficial in scenes with multiple light sources with few overlap between their influence areas (e.g. a building with many disconnected rooms and interior lights).

Options for the DLS cache:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''lightstrategy.entry.radius''' || float || 0.0 || || N/A || Entry radius in meters, automatic radius estimation is used if the radius is set to 0
|-
|'''lightstrategy.entry.normalangle''' || float || 25.0 || || N/A ||
|-
|'''lightstrategy.entry.maxpasses''' || int || 1024 || || N/A ||
|-
|'''lightstrategy.entry.convergencethreshold''' || float || 0.05 || || N/A ||
|-
|'''lightstrategy.entry.warmupsamples''' || int || 24 || || N/A ||
|-
|'''lightstrategy.targetcachehitratio''' || float || 0.995 || || N/A ||
|-
|'''lightstrategy.maxdepth''' || int || 4 || || N/A ||
|-
|'''lightstrategy.maxsamplescount''' || int || 10000000 || || N/A ||
|-
|'''lightstrategy.persistent.file''' || string || "" || || N/A ||
|-
|'''lightstrategy.persistent.safesave''' || bool || 1 || || N/A ||

|}

==Accelerator==

The ray/triangle intersection accelerator to use for the rendering is defined by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''accelerator.type''' || string || "AUTO" || "AUTO", "BVH", "MBVH", "EMBREE" || "AUTO" || The intersection accelerator. "AUTO" will select the best one available for the current [[LuxRays]] intersection device. "EMBREE" is currently usable only on CPU render engines
|-
|'''accelerator.instances.enable''' || bool || 1 || 0 or 1 || 0 or 1 || Enable instance support (or disable in order to slightly increase rendering speed)
|}

==Epsilon==

Minimum and maximum allowed value for scene epsilon can be define by the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Theoretical range
!Recommended range
!Description
|-
|'''scene.epsilon.min''' || float || 1e-5f || Any float value || 1e-6f ≤ x ≤ 1e-1f || Minimum allowed value for scene epsilon
|-
|'''scene.epsilon.max''' || float || 1e-1f || Any float value || 1e-3f ≤ x ≤ 1e+2f || Maximum allowed value for scene epsilon
|}

==Film==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.safesave''' || bool || 1 || enable "safe save" of Film serialization. A backup of the output is always valid even in the case of a system failure.
|}

===Film OpenCL Options===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.opencl.enable''' || bool || 1 || enable OpenCL film operations
|-
|'''film.opencl.platform''' || unsigned int || -1 || choose which platform will be used by the film operations. (0 is first platform, 1 second and so on. -1 for all)
|-
|'''film.opencl.device''' || unsigned int || -1 || choose which device will be used by the film operations. (0 is first device, 1 second and so on. -1 for first GPU device)
|}

===Film Outputs (aka AOVs)===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.safesave''' || bool || 1 || enable "safe save" for Film outputs. A backup of the output is always valid even in the case of a system failure
|}

The film object supports many types of outputs (aka AOVs). The complete list of supported output types:

{| class="wikitable" cellspacing="2"
!Name
!Type
|-
|'''RGB''' || HDR
|-
|'''RGBA''' || HDR
|-
|'''RGB_IMAGEPIPELINE''' || HDR/LDR
|-
|'''RGBA_IMAGEPIPELINE''' || HDR/LDR
|-
|'''ALPHA''' || HDR/LDR
|-
|'''DEPTH''' || HDR
|-
|'''POSITION''' || HDR
|-
|'''GEOMETRY_NORMAL''' || HDR
|-
|'''SHADING_NORMAL''' || HDR
|-
|'''MATERIAL_ID''' || LDR
|-
|'''DIRECT_DIFFUSE''' || HDR
|-
|'''DIRECT_GLOSSY''' || HDR
|-
|'''EMISSION''' || HDR
|-
|'''INDIRECT_DIFFUSE''' || HDR
|-
|'''INDIRECT_GLOSSY''' || HDR
|-
|'''INDIRECT_SPECULAR''' || HDR
|-
|'''MATERIAL_ID_MASK''' || HDR/LDR
|-
|'''DIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''INDIRECT_SHADOW_MASK''' || HDR/LDR
|-
|'''RADIANCE_GROUP''' || HDR/LDR
|-
|'''UV''' || HDR/LDR
|-
|'''RAYCOUNT''' || HDR/LDR
|-
|'''BY_MATERIAL_ID''' || HDR/LDR
|-
|'''IRRADIANCE''' || HDR
|-
|'''OBJECT_ID''' || LDR
|-
|'''OBJECT_ID_MASK''' || HDR/LDR
|-
|'''BY_OBJECT_ID''' || HDR/LDR
|-
|'''SAMPLECOUNT''' || HDR/LDR
|-
|'''CONVERGENCE''' || HDR/LDR
|-
|'''NOISE''' || HDR/LDR
|-
|'''SERIALIZED_FILM''' || N/A
|-
|'''MATERIAL_ID_COLOR''' || HDR/LDR
|}

Outputs are enabled with the following properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.outputs.<index>.type''' || string || || Type of output, e.g. "RGBA" or "ALPHA" (see the list above for the available types)
|-
|'''film.outputs.<index>.filename''' || string || || Filename to use when saving the output. The filename should use ".exr" as extension for HDR outputs and ".png" for LDR outputs (see list above for which output is HDR and which LDR)
|-
|'''film.outputs.<index>.id''' || int || || Specify for the following outputs: '''MATERIAL_ID_MASK''', '''RADIANCE_GROUP''', '''BY_MATERIAL_ID''', '''OBJECT_ID_MASK''', '''BY_OBJECT_ID''' (to choose the object ID, material ID or radiance group ID of the output)
|-
|'''film.outputs.<index>.index''' || int || || Specify for an imagepipeline output (RGB_IMAGEPIPELINE or RGBA_IMAGEPIPELINE) to select the imagepipeline of the output. For example, if you have 3 imagepipelines defined, and you want to specify the output of the third imagepipeline, use 2 for the ".index" property of the output
|}

Note that the Bidir engine does not support all AOVs.
Not supported by Bidir are: EMISSION, DIRECT_DIFFUSE, DIRECT_GLOSSY, INDIRECT_DIFFUSE, INDIRECT_GLOSSY, INDIRECT_SPECULAR, DIRECT_SHADOW_MASK, INDIRECT_SHADOW_MASK, IRRADIANCE, RAYCOUNT.

This is the list of output channel data types and sizes:

{| class="wikitable" cellspacing="2"
!Output type
!Data type
!Size
!Description
|-
|RGB||float||film width x film height x 3||R, G, B
|-
|RGB_IMAGEPIPELINE||float||film width x film height x 3||R, G, B
|-
|RGBA||float||film width x film height x 4||R, G, B, A
|-
|ALPHA||float||film width x film height x 1||Alpha value [0, 1]
|-
|DEPTH||float||film width x film height x 1||Camera distance
|-
|POSITION||float||film width x film height x 3||World X, Y, Z
|-
|GEOMETRY_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|SHADING_NORMAL||float||film width x film height x 3||Normal vector X, Y, Z
|-
|DIRECT_DIFFUSE||float||film width x film height x 3||Diffuse R, G, B
|-
|DIRECT_GLOSSY||float||film width x film height x 3||Glossy R, G, B
|-
|EMISSION||float||film width x film height x 3||Emission R, G, B
|-
|INDIRECT_DIFFUSE||float||film width x film height x 3||Indirect diffuse R, G, B
|-
|INDIRECT_GLOSSY||float||film width x film height x 3||Indirect glossy R, G, B
|-
|INDIRECT_SPECULAR||float||film width x film height x 3||Indirect specular R, G, B
|-
|MATERIAL_ID_MASK||float||film width x film height x 1||Material mask [0, 1]
|-
|DIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|INDIRECT_SHADOW_MASK||float||film width x film height x 1||Shadow mask [0, 1]
|-
|RADIANCE_GROUP||float||film width x film height x 3||R, G, B
|-
|UV||float||film width x film height x 2||Texture coordinates U, V
|-
|RAYCOUNT||float||film width x film height x 1||Ray count
|-
|BY_MATERIAL_ID||float||film width x film height x 3||By material ID
|-
|MATERIAL_ID||uint||film width x film height x 1||Material ID
|-
|IRRADIANCE||float||film width x film height x 3||R, G, B
|-
|OBJECT_ID_MASK||float||film width x film height x 1||Object mask [0, 1]
|-
|BY_OBJECT_ID||float||film width x film height x 3||By object ID
|-
|OBJECT_ID||uint||film width x film height x 1||Object ID
|-
|SAMPLECOUNT||uint||film width x film height x 1||Sample count
|-
|CONVERGENCE||float||film width x film height x 1||The distance of each pixel from the convergence threshold
|-
|NOISE||float||film width x film height x 1||The noise estimated for each pixel
|-
|SERIALIZED_FILM||N/A||N/A||The complete Film serialized in binary format
|-
|MATERIAL_ID_COLOR||float||film width x film height x 3||Material ID converted to colors (with anti-aliasing)
|}

===Film Channels===

Film channels are implicitly enabled by declaring film outputs (even if the output is never used). For instance, declaring a "RGBA" output will automatically enable "RADIANCE_PER_PIXEL_NORMALIZED" (and "RADIANCE_PER_SCREEN_NORMALIZED" for BIDIRCPU) and "ALPHA".
The supported channels are:

{| class="wikitable" cellspacing="2"
!Channel type
!Data type
!Size
!Last element is weight ?
!Note
|-
|CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED||float||film width x film height x 4||Yes||One for each radiance group. Eye paths radiance.
|-
|CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED||float||film width x film height x 3||No||One for each radiance group. Light paths radiance. Used only by LIGHTCPU and BIDIRCPU.
|-
|CHANNEL_ALPHA||float||film width x film height x 2||Yes||
|-
|CHANNEL_RGB_IMAGEPIPELINE||float||film width x film height x 3||No||
|-
|CHANNEL_DEPTH||float||film width x film height x 1||No||
|-
|CHANNEL_POSITION||float||film width x film height x 3||No||
|-
|CHANNEL_GEOMETRY_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_SHADING_NORMAL||float||film width x film height x 3||No||
|-
|CHANNEL_MATERIAL_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_DIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_DIRECT_GLOSSY||float||film width x film height x 4||Yes||
|-
|CHANNEL_EMISSION||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_DIFFUSE||float||film width x film height x 4||Yes||
|-
|CHANNEL_INDIRECT_SPECULAR||float||film width x film height x 4||Yes||
|-
|CHANNEL_MATERIAL_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_DIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_INDIRECT_SHADOW_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_UV||float||film width x film height x 2||No||
|-
|CHANNEL_RAYCOUNT||float||film width x film height||No||
|-
|CHANNEL_BY_MATERIAL_ID||float||film width x film height x 4||Yes||
|-
|CHANNEL_IRRADIANCE||float||film width x film height x 4||Yes||
|-
|CHANNEL_OBJECT_ID||u_int||film width x film height x 1||No||
|-
|CHANNEL_OBJECT_ID_MASK||float||film width x film height x 2||Yes||
|-
|CHANNEL_BY_OBJECT_ID||float||film width x film height x 4||Yes||
|}

This is the list of channels enabled by each output:

{| class="wikitable" cellspacing="2"
!Output
!Enabled channels
|-
|'''RGB''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''RGB_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''RGBA_IMAGEPIPELINE''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU), ALPHA
|-
|'''ALPHA''' || ALPHA
|-
|'''DEPTH''' || DEPTH
|-
|'''POSITION''' || DEPTH, POSITION
|-
|'''GEOMETRY_NORMAL''' || DEPTH, GEOMETRY_NORMAL
|-
|'''SHADING_NORMAL''' || DEPTH, SHADING_NORMAL
|-
|'''MATERIAL_ID''' || DEPTH, MATERIAL_ID
|-
|'''DIRECT_DIFFUSE''' || DIRECT_DIFFUSE
|-
|'''DIRECT_GLOSSY''' || DIRECT_GLOSSY
|-
|'''EMISSION''' || EMISSION
|-
|'''INDIRECT_DIFFUSE''' || INDIRECT_DIFFUSE
|-
|'''INDIRECT_GLOSSY''' || INDIRECT_GLOSSY
|-
|'''INDIRECT_SPECULAR''' || INDIRECT_SPECULAR
|-
|'''MATERIAL_ID_MASK''' || MATERIAL_ID, MATERIAL_ID_MASK
|-
|'''DIRECT_SHADOW_MASK''' || DIRECT_SHADOW_MASK
|-
|'''INDIRECT_SHADOW_MASK''' || INDIRECT_SHADOW_MASK
|-
|'''RADIANCE_GROUP''' || CHANNEL_RADIANCE_PER_PIXEL_NORMALIZED, CHANNEL_RADIANCE_PER_SCREEN_NORMALIZED (only for LIGHTCPU and BIDIRCPU)
|-
|'''UV''' || DEPTH, UV
|-
|'''RAYCOUNT''' || DEPTH, RAYCOUNT
|-
|'''BY_MATERIAL_ID''' || BY_MATERIAL_ID
|-
|'''IRRADIANCE''' || IRRADIANCE
|-
|'''OBJECT_ID''' || DEPTH, OBJECT_ID
|-
|'''OBJECT_ID_MASK''' || OBJECT_ID, OBJECT_ID_MASK
|-
|'''BY_OBJECT_ID''' || BY_OBJECT_ID
|}

Note: CHANNEL_RGB_IMAGEPIPELINE is always enable and the result of running the image pipeline.

===Image pipeline===

It is possible to define multiple image pipelines at the same time by using the '''film.imagepipelines.<pipeline #>.''' properties prefix. Each image pipeline takes as input the raw rendering and is a chain off image pipeline plugins. Each plugin receives previous plugin output and produces a new output.

====Radiance Group====

Radiance groups are used to get only the contribution of a group of lights in the scene. 
Lights can be grouped by setting their [[#Common_parameters | '''.id''']] property to the same number, on materials this is done with the [[#Light_emission | '''.emission.id''']] property. 

Note that the OpenCL engines only support up to 8 radiance groups (one of them is the default group).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.globalscale''' || float|| 1 || global weighting of radiance group
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.temperature ''' || float || 6500.0 || light temperature
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.<id>.rgbscale''' || vector || 1.0 1.0 1.0 || light color
|-
|'''film.imagepipelines.<pipeline #>.radiancescales.radiancescales.<id>.enabled''' || bool || 1 || enable radiance group
|}

====Image pipeline plug-ins====

=====Type: TONEMAP_LINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || linear tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 1.0 || tonemapping scale
|}

=====Type: TONEMAP_REINHARD02=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_REINHARD02" || reinhard tonemapping
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.prescale''' || float || 1.0 || reinhard prescale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.postscale''' || float || 1.2 || reinhard postscale
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.burn''' || float || 3.75 || reinhard burn
|}

=====Type: TONEMAP_AUTOLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_AUTOLINEAR" || automatic linear tonemapping
|}

=====Type: TONEMAP_LUXLINEAR=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LUXLINEAR" || linear tonemapping with real camera settings
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sensitivity''' || float || 100.0 || ISO sensitivity
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.exposure''' || float || 0.001 || exposure time
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.fstop''' || float || 2.8 || f/aperture
|}

=====Type: NOP=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipeline.<pipeline #>.<plugin #>.type''' || string || "NOP" || no parameters tonemapper
|}

=====Type: GAMMA_CORRECTION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "TONEMAP_LINEAR" || gamma correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.value''' || float || 2.2 || gamma value
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.table.size''' || unsigned int || 4096 || resolution
|}

=====Type: OUTPUT_SWITCHER=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OUTPUT_SWITCHER" || overwrite output
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.channel''' || string || "DEPTH" || channel whose values are used to overwrite
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.index''' || unsigned int || 0 || index
|}

=====Type: GAUSSIANFILTER_3x3=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "GAUSSIANFILTER_3x3" || gaussian filter
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.15 || blurring weight
|}

=====Type: CAMERA_RESPONSE_FUNC=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || CAMERA_RESPONSE_FUNC || analog camera film simulation
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.name''' || string || "Advantix_100CD" || film type
|}

=====Type: BACKGROUND_IMG=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || BACKGROUND_IMG || show the background image where alpha < 1 (simple compositing)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || ... || background image path (e.g scenes/simple-mat/sky.exr)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.gamma''' || float || 2.2 || background image gamma
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.storage ''' || string || auto || background image storage type
|}
Note: When the size of the background image differs from the film size, it will be stretched to fit the film size.

=====Type: BLOOM=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "BLOOM" || bloom effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.radius''' || float || 0.07 || how large the bloom effect is in % of the image size (i.e. 1.0 = all image)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.weight''' || float || 0.25 || how strong the effect is (i.e. 0.0 = nothing, 1.0 = max. strength)
|}

=====Type: VIGNETTING=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "VIGNETTING" || vignetting effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || 0.4 || vignetting strength
|}

=====Type: COLOR_ABERRATION=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_ABERRATION" || color aberration effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || color aberration amount
|}

=====Type: MIST=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "MIST" || aerial perspective effect (fake fog)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.color''' || spectrum|| [1, 1, 1] || mist color
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.amount''' || float || 0.005 || mist amount
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.startdistance''' || float || 0 || distance from camera until where the mist effect has zero effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.enddistance''' || float || 10000 || distance from camera from where the mist effect has maximum effect
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.excludebackground''' || bool || false || Do not apply mist effect on pixels with infinite distance to the camera
|}

=====Type: CONTOUR_LINES=====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "CONTOUR_LINES" || contour lines for IRRADIANCE AOV
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.range''' || float|| ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.scale''' || float || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.steps''' || int || ? || ?
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.zerogridsize''' || int || ? || ?
|}

=====Type: WHITE_BALANCE =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "WHITE_BALANCE" || White temperature correction
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.temperature''' || unsigned int|| 6500 || Target image temperature in Kelvin
|-
|}

=====Type: COLOR_LUT =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "COLOR_LUT" || Applies .cube LUT (look-up-table) to the input
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.file''' || string || "lut.cube" || Filepath to a [https://wwwimages2.adobe.com/content/dam/acom/en/products/speedgrade/cc/pdfs/cube-lut-specification-1.0.pdf .cube LUT file]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.strength''' || float || 1.0 || Linear interpolation between input (0.0) and output (1.0) of the plugin
|-
|}

=====Type: INTEL_OIDN =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "INTEL_OIDN" || Denoises the image using [https://github.com/OpenImageDenoise/oidn Intel OIDN]
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.filter.type''' || string || "RT" ||
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.oidnmemory''' || int || 6000 || Approximate maximum amount of memory to use in megabytes (actual memory usage may be higher). Limiting memory usage may cause slower denoising due to internally splitting the image into overlapping tiles
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

=====Type: OPTIX_DENOISER =====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.type''' || string || "OPTIX_DENOISER" || Denoises the image using the Nvidia OptiX denoiser
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.minspp''' || unsigned int || 0 || Minimum amount of samples to be rendered before the plugin is run (at lower sample numbers, it does not modify the input)
|-
|'''film.imagepipelines.<pipeline #>.<plugin #>.sharpness''' || float || 0.1 || Linear interpolation between the denoised result (0.0) and the noisy input (1.0)
|-
|}

===Film Subregion===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.subregion''' || vector || ... || <xstart> <xstop> <ystart> <ystop>
|}

===Rendering halt conditions===

By default, a LuxCore rendering will never stop however you can enable one or multiple halt conditions:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''batch.haltnoisethreshold''' || float || -1.0 || enable image convergence test and stops when the error is under the defined value. Use a value like "n / 256.0" where n is the level of error you are looking for. It may be hard to achieve a level of error smaller than 3.0 / 256.0. -1.0 disables the halt condition.
|-
|'''batch.haltnoisethreshold.warmup''' || unsigned int || 64 || number of average samples per pixel before to start the convergence test
|-
|'''batch.haltnoisethreshold.step''' || unsigned int || 64 || number of average samples per pixel between two tests
|-
|'''batch.haltnoisethreshold.filter.enable''' || bool || 1 || if the CONVERGENCE AOV (generated by the batch.haltnoisethreshold) should be filtered or not with a 3x3 box filter
|-
|'''batch.haltnoisethreshold.stoprendering.enable''' || bool || 1 || Set this to 0 (false) if you only want to use the haltnoisethreshold settings for adaptive sampling in an endless render
|-
|'''batch.haltnoisethreshold.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for stopping
|-
|'''batch.halttime''' || float || 0.0 || number of seconds before stopping the rendering
|-
|'''batch.haltspp''' || unsigned int || 0 || number of average samples per pixel before stopping the rendering
|}

===Noise estimation===

Image noise can be estimated and its result can be used to drive the Sobol and Random samplers to focus its sampling in the noisier regions.
Setting any of these properties will enable the noise estimation.
The adaptiveness strength is a Sampler property.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''film.noiseestimation.warmup''' || unsigned int || 32 || number of average samples per pixel before to start the convergence test
|-
|'''film.noiseestimation.step''' || unsigned int || 32 || number of average samples per pixel between two tests
|-
|'''film.noiseestimation.filter.scale''' || unsigned int || 4 || Box filter scale used to filter the NOISE AOV (generated by the noise estimation). Set to 0 to disable.
|-
|'''film.noiseestimation.index''' || unsigned int || 0 || Film pipeline index used to estimate noise for adaptive sampling
|-
|}

=Scene file=

==Camera==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.camera.type''' || string || "perspective" || "perspective", "orthographic", "environment" (360° panorama mapped in latlong format) or "stereo"
|-
|'''scene.camera.lookat.orig''' || point (float float float) || 0.0 10.0 0.0 || camera location
|-
|'''scene.camera.lookat.target''' || point (float float float) || 0.0 0.0 0.0 || camera target
|-
|'''scene.camera.up''' || vector (float float float) || (0.0, 0.0, 1.0) || camera up vector
|-
|'''scene.camera.fieldofview''' || float || 45.0 || field of view
|-
|'''scene.camera.screenwindow''' || vector || 0.0 1.0 0.0 1.0 || <xstart> <xstop> <ystart> <ystop>
|-
|'''scene.camera.shutteropen''' || float || 0.0 || camera shutter open time (used for motion blur)
|-
|'''scene.camera.shutterclose''' || float || 0.0 || camera shutter close time (used for motion blur)
|-
|'''scene.camera.autovolume.enable''' || bool || true || try automatically to discover scene.camera.volume
|-
|'''scene.camera.volume''' || string || || the initial volume rays will travel in
|}

The camera supports motion blur. See [[ LuxCore_SDL_Reference_Manual_v2.0#Object_Motion_Blur | Object Motion Blur ]]. 
(Only difference being that instead of the prefix '''scene.objects.<object name>''', the prefix '''scene.camera''' is used when setting motion properties of the camera)

==Textures==

Check [[LuxCoreRender_Textures|LuxCoreRender Textures]] for a high level description and examples of the textures.

===Mapping===

Some texture (mostly procedural textures) supports 2D or 3D mapping parameters:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping2d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.rotation''' || float || 0.0 || UV rotation (in degrees)
|-
|'''scene.textures.<texture name>.mapping.uvscale''' || UV || 1.0 1.0 || UV scale
|-
|'''scene.textures.<texture name>.mapping.uvdelta''' || UV || 0.0 0.0 || UV translation
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "uvmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.mapping.type''' || string || "globalmapping3d" || type of mapping
|-
|'''scene.textures.<texture name>.mapping.transformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix
|}

===Type: add===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "add" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: subtract===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "subtract" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: band===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "band" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5|| texture name or constant
|-
|'''scene.textures.<texture name>.interpolation''' || string || "linear"|| "linear", "cubic" or "none"
|-
|'''scene.textures.<texture name>.offset[0..n]''' || float || 0.0 || multiple offsets in the range of [0.0, 1.0]
|-
|'''scene.textures.<texture name>.value[0..n]''' || spectrum || 1.0 1.0 1.0 || a value for each offset
|}

===Type: blender_blend===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_blend" || type of texture
|-
|'''scene.textures.<texture name>.progressiontype''' || string || "linear" || linear, quadratic, easing, diagonal, spherical, quadratic_spherical, halo or radial
|-
|'''scene.textures.<texture name>.direction''' || string || "horizontal" || horizontal or vertical
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_clouds===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_clouds" || type of texture
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || hard_noise or soft_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_distortednoise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_distortednoise" || type of texture
|-
|'''scene.textures.<texture name>.noise_distortion''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.distortion''' || float || 1 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_magic===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_magic" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_marble===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_marble" || type of texture
|-
|'''scene.textures.<texture name>.marbletype''' || string || "soft" || soft, sharp or sharper
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_musgrave===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_musgrave" || type of texture
|-
|'''scene.textures.<texture name>.musgravetype''' || string || "multifractal" || multifractal, ridged_multifractal, hybrid_multifractal, fBM or hetero_terrain
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.dimension''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.lacunarity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.offset''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.octaves''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_noise===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_noise" || type of texture
|-
|'''scene.textures.<texture name>.noisedepth''' || int || 2 || min 0, max 25
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_stucci===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_stucci" || type of texture
|-
|'''scene.textures.<texture name>.stuccitype''' || string || "plastic" || plastic, wall_in or wall_out
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_wood===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || bands, rings, bandnoise or ringnoise
|-
|'''scene.textures.<texture name>.noisebasis''' || string || "blender_original" || blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2_f1, voronoi_crackle or cell_noise
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || sin, saw or tri
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || soft_noise or hard_noise
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: blender_voronoi===

Emulate Blender procedural texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blender_voronoi" || type of texture
|-
|'''scene.textures.<texture name>.intensity''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.distmetric''' || string || "actual_distance" || actual_distance, distance_squared, manhattan, chebychev, minkowski_half, minkowski_four or minkowski
|-
|'''scene.textures.<texture name>.w1''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.w2''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w3''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.w4''' || float || 0.0 ||
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 ||
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 ||
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 ||
|}

===Type: brick===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "brick" || type of texture
|-
|'''scene.textures.<texture name>.bricktex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.mortartex''' || texture || 0.2 0.2 0.2 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodtex''' || texture || 1.0 1.0 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.brickmodbias''' || float || 0.0 || With bias = -1, only the bricktex is used for the brick color. With bias between -1 and 1, a pseudo-random interpolation between bricktex and brickmodtex is used as brick color. With bias = 1, only the brickmodtex is used for the brick color.
|-
|'''scene.textures.<texture name>.brickbond''' || string || "running" || "flemish", "english", "herringbone", "basket" or "chain link"
|-
|'''scene.textures.<texture name>.brickwidth''' || float || 0.3 || brick width
|-
|'''scene.textures.<texture name>.brickheight''' || float || 0.1 || brick height
|-
|'''scene.textures.<texture name>.brickdepth''' || float || 0.15 || brick depth
|-
|'''scene.textures.<texture name>.mortarsize''' || float || 0.01 ||mortar size
|-
|'''scene.textures.<texture name>.brickrun''' || float || 0.75 || brick run
|}

This texture supports 3D mapping.

===Type: checkerboard3d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard3d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 3D mapping.

===Type: checkerboard2d===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "checkerboard2d" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: constfloat1===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat1" || type of texture
|-
|'''scene.textures.<texture name>.value''' || float || 1.0 || constant value
|}

===Type: constfloat3===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "constfloat3" || type of texture
|-
|'''scene.textures.<texture name>.value''' || spectrum || (1.0, 1.0, 1.0) || RGB constant value
|}

===Type: densitygrid===

You can use ".data", ".data3" or ".openvdb.file" to define the 3D grid values.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "densitygrid" || type of texture
|-
|'''scene.textures.<texture name>.nx''' || unsigned int || || grid x size
|-
|'''scene.textures.<texture name>.ny''' || unsigned int || || grid y size
|-
|'''scene.textures.<texture name>.nz''' || unsigned int || || grid z size
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of grid wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.storage''' || string || "half" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.data''' || float || || vector grid values (total count: nx * ny * nz)
|-
|'''scene.textures.<texture name>.data3''' || float || || vector grid values (total count: nx * ny * nz * 3)
|-
|'''scene.textures.<texture name>.openvdb.file''' || string || || OpenVDB file name
|-
|'''scene.textures.<texture name>.openvdb.grid''' || string || || OpenVDB grid name to read from the file
|}

===Type: dots===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dots" || type of texture
|-
|'''scene.textures.<texture name>.inside''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.outside''' || texture || 0.0 || texture name or constant
|}

This texture supports 2D mapping.

===Type: fbm===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fbm" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: fresnelapproxk===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxk" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: fresnelapproxn===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "fresnelapproxn" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || (0.5, 0.5, 0.5) || texture name or constant
|}

===Type: hitpointalpha===

Use the value obtained by interpolating triangle vertices alphas.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointalpha" || type of texture
|}

===Type: hitpointcolor===

Use the color obtained by interpolating triangle vertices colors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointcolor" || type of texture
|}

===Type: hitpointgrey===

Use the value obtained by interpolating triangle vertices colors, mapped to a float value (RGB converted into greyscale).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hitpointgrey" || type of texture
|-
|'''scene.textures.<texture name>.channel''' || int || -1 || the index of the RGB channel to use. -1 means the luminance of the RGB value
|}

===Type: hsv===

Hue saturation value manipulation.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "hsv" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input color that will be manipulated
|-
|'''scene.textures.<texture name>.hue''' || texture || 0.5 || shift in hue (range: 0..1)
|-
|'''scene.textures.<texture name>.saturation''' || texture || 1.0 || saturation (range: 0..inf)
|-
|'''scene.textures.<texture name>.value''' || texture || 1.0 || brightness multiplier (range: 0..inf)
|}

===Type: imagemap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "imagemap" || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || "image.png" || name of the image file
|-
|'''scene.textures.<texture name>.gamma''' || float || 2.2 || gamma correction value used in the image
|-
|'''scene.textures.<texture name>.gain''' || float || 1.0 || image values are multiplied by gain value
|-
|'''scene.textures.<texture name>.storage''' || string || "auto" || select the type of memory storage: "auto", "byte", "half", "float"
|-
|'''scene.textures.<texture name>.wrap''' || string || "repeat" || select the type of image map wrapping mode: "repeat", "black", "white", "clamp"
|-
|'''scene.textures.<texture name>.channel''' || string || "default" || extract from the image only the selected channels: "default", "red", "green", "blue", "alpha", "mean", "colored_mean", "rgb"
|}

===Type: normalmap===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "normalmap" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0 0 0 || input. Is treated as an XYZ vector in tangent space.
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || multiplier for adjusting normalmap height
|}

===Type: marble===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "marble" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|-
|'''scene.textures.<texture name>.scale''' || float || 1.0 || marble scale
|-
|'''scene.textures.<texture name>.variation''' || float || 0.2 || marble variation
|}

This texture supports 3D mapping.

===Type: mix===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "mix" || type of texture
|-
|'''scene.textures.<texture name>.amount''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.texture1''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: scale===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "scale" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: uv===

This procedural texture has no parameters aside from the support of 2D mapping.

===Type: windy===

This procedural texture has no parameters aside from the support of 3D mapping.

===Type: wood===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wood" || type of texture
|-
|'''scene.textures.<texture name>.woodtype''' || string || "bands" || "bands", "rings", "bandnoise" or "ringnoise"
|-
|'''scene.textures.<texture name>.noisebasis2''' || string || "sin" || "sin", "saw" or "tri"
|-
|'''scene.textures.<texture name>.noisetype''' || string || "soft_noise" || "soft_noise" or "hard_noise"
|-
|'''scene.textures.<texture name>.noisesize''' || float || 0.25 || noise size
|-
|'''scene.textures.<texture name>.turbulence''' || float || 5.0 || noise turbulence
|-
|'''scene.textures.<texture name>.bright''' || float || 1.0 || bright
|-
|'''scene.textures.<texture name>.contrast''' || float || 1.0 || contrast
|}

This texture supports 3D mapping.

===Type: wrinkled===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "wrinkled" || type of texture
|-
|'''scene.textures.<texture name>.octaves''' || int || 8 || noise octaves
|-
|'''scene.textures.<texture name>.roughness''' || float || 0.5 || noise roughness
|}

This texture supports 3D mapping.

===Type: abs===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "abs" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|}

===Type: clamp===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "clamp" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.min''' || float || 0.0 || lower boundary of the clamping
|-
|'''scene.textures.<texture name>.max''' || float || 1.0 || upper boundary of the clamping
|}

===Type: divide===

Note: If texture2 (the divisor) is 0, 0 is returned.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "divide" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant (dividend)
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant (divisor)
|}

===Type: remap===

This texture brings the value from the source range into the target range.

Note: The value is clamped into source range before performing the remap operation, and the resulting number is also clamped into the target range.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "remap" || type of texture
|-
|'''scene.textures.<texture name>.value''' || texture || 0.5 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.sourcemax''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmin''' || texture || 0.0 || texture name or constant
|-
|'''scene.textures.<texture name>.targetmax''' || texture || 1.0 || texture name or constant
|}

===Type: objectid===

Raw object ID (range 0 to 0xfffffffe).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectid" || type of texture
|}

===Type: objectidcolor===

Object ID interpreted as color. 
The object ID is a 4 byte unsigned int. To convert to color, the lower three bytes are interpreted as r, g, b values (each range 0 to 255). The highest byte is ignored.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidcolor" || type of texture
|}

===Type: objectidnormalized===

Normalized object ID (range 0 to 1).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "objectidnormalized" || type of texture
|}

===Type: dotproduct ===

Dot product of the two input vectors.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "dotproduct" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: power ===

pow(base, exponent)

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "power" || type of texture
|-
|'''scene.textures.<texture name>.base''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.exponent''' || texture || 1.0 || texture name or constant
|}

===Type: lessthan ===

returns 1 if texture1 < texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lessthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: greaterthan ===

returns 1 if texture1 > texture2, 0 if otherwise.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "greaterthan" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|}

===Type: shadingnormal ===

Returns the shading normal of the mesh at the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "shadingnormal" || type of texture
|}

===Type: position ===

Returns the position of the hitpoint.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "position" || type of texture
|}

===Type: splitfloat3 ===

Extract a channel from a float3 texture. Can for example be used to get the R, G or B channel of a color texture, or to get the X, Y or Z components of a vector texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "splitfloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.channel''' || int || 0 || the channel to get from the input texture. 0 for first channel, 1 for second, 2 for third channel
|}

===Type: makefloat3 ===

Combine three float textures into one float3 texture.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "makefloat3" || type of texture
|-
|'''scene.textures.<texture name>.texture1''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture2''' || texture || 1.0 || texture name or constant
|-
|'''scene.textures.<texture name>.texture3''' || texture || 1.0 || texture name or constant
|}

===Type: blackbody===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "blackbody" || type of texture
|-
|'''scene.textures.<texture name>.temperature''' || float || 6500 || emission temperature
|-
|'''scene.textures.<texture name>.normalize''' || bool || false || normalize the output
|}

===Type: irregulardata===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "irregulardata" || type of texture
|-
|'''scene.textures.<texture name>.wavelengths''' || vector || 580.0 620.0 660.0|| wavelenghts
|-
|'''scene.textures.<texture name>.data''' || vector || 0.0 0.000015 0.0|| data (length should match wavelength's length)
|}

===Type: lampspectrum===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || "lampspectrum" || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || "Daylight" || lamp light spectrum
|}

===Type: Fresnel Textures===

Textures for loading optical data

====Type: fresnelcolor====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelcolor || type of texture
|-
|'''scene.textures.<texture name>.kr''' || vector || 0.5 0.0 0.0 || reflection color
|}

====Type: fresnelpreset====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.name''' || string || aluminium || fresnel preset ("aluminium", "silver", "copper", "gold" or "amorphous carbon")
|}

====Type: fresnelsopra====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Au.nk)
|}

====Type: fresnelluxpop====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || fresnelpreset || type of texture
|-
|'''scene.textures.<texture name>.file''' || string || ... || nk file path (e.g scenes/luxball/Cr.nk)
|}

====Type: distort====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.textures.<texture name>.type''' || string || distort || type of texture
|-
|'''scene.textures.<texture name>.texture''' || texture || 0.0 || texture name or constant; input texture
|-
|'''scene.textures.<texture name>.offset''' || texture || 0.0 || texture name or constant; offset to add to the hitpoint coordinates and UV values before evaluating the input texture
|-
|'''scene.textures.<texture name>.strength''' || float || 1.0 || strength multiplier, is multiplied with the offset
|}

==Volumes==

Check [[LuxCoreRender_Volumes|LuxCoreRender Volumes]] for a high level description and examples of the volumes.

All volumes share these properties

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|-
|'''scene.volumes.<volume name>.priority''' || unsigned int|| 0|| volume priority (when volumes overlap, the one with highest priority overrides the others)
|-
|'''scene.volumes.<volume name>.ior''' || texture|| ... || index of refraction
|-
|'''scene.volumes.<volume name>.absorption''' || texture || ... || absorption texture
|-
|'''scene.volumes.<volume name>.emission ''' || texture || ... || emission
|-
|'''scene.volumes.<volume name>.emission.id ''' || unsigned int || ... || emission ID
|}

===Volume: Clear===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || clear || volume type
|}

===Volume: Homogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || homogeneous|| volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|}

===Volume: Heterogeneous===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.volumes.<volume name>.type''' || string || heterogeneous || volume type
|-
|'''scene.volumes.<volume name>.scattering''' || texture || ... || scattering texture
|-
|'''scene.volumes.<volume name>.asymmetry''' || texture || ... || asymmetry texture
|-
|'''scene.volumes.<volume name>.multiscattering''' || bool || ... || multiscattering
|-
|'''scene.volumes.<volume name>.steps.size''' || float || ... || step size
|-
|'''scene.volumes.<volume name>.steps.maxcount''' || unsigned int || ... || step maximum count
|}

==Materials==

Check [[LuxCoreRender_Materials|LuxCoreRender Materials]] for a high level description and examples of the materials.

===Common properties===

Common material properties:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.bumptex''' || texture || || texture to use for the bump mapping
|-
|'''scene.materials.<material name>.normaltex''' || texture || || texture to use for the normal mapping
|-
|'''scene.materials.<material name>.samples''' || int || -1 || number of rays used to sample this material. -1 means use the default global value. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.diffuse.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.glossy.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.visibility.indirect.specular.enable''' || bool || true || if this material is visible in indirect rays. This property is an hint and the render engine can ignore this information.
|-
|'''scene.materials.<material name>.bumpsamplingdistance''' || float || 0.001 || set the offset used to sample bump/normal mapping.
|-
|'''scene.materials.<material name>.volume.interior''' || string || vol1 || name of interior volume (for volume rendering)
|-
|'''scene.materials.<material name>.volume.exterior''' || string || vol2 || name of exterior volume (for volume rendering)
|-
|'''scene.materials.<material name>.id''' || int|| ... || material id
|-
|'''scene.materials.<material name>.transparency''' || texture || 1.0 || transparency of the material. 1 for opaque, 0 for fully transparent
|-
|'''scene.materials.<material name>.shadowcatcher.enable''' || bool || false || If true, the material will be transparent where hit by direct light and opaque otherwise (alpha transparency). Used for compositing.
|}

====Normal maps====
Normal maps are set first as a texture type and then assigned to the material. For example:

<blockquote><pre>
scene.textures.normmap.type = imagemap
scene.textures.normmap.file = scenes/bump/normal.png
scene.textures.normmap.gamma = 1

scene.materials.mat_white.type = matte
scene.materials.mat_white.kd = 0.8 0.8 0.8
scene.materials.mat_white.normaltex = normmap
</pre></blockquote>

====Light emission====

All materials can emit light:

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.emission''' || texture || 0.0 0.0 0.0 || color of the emitted light
|-
|'''scene.materials.<material name>.emission.gain''' || spectrum || 1.0 1.0 1.0 || multiplier for lamp brigthness
|-
|'''scene.materials.<material name>.emission.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.materials.<material name>.emission.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.materials.<material name>.emission.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.materials.<material name>.emission.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light
|-
|'''scene.materials.<material name>.emission.iesblob''' || blob || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.materials.<material name>.emission.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.materials.<material name>.emission.samples''' || int || -1 || the number of shadow ray to trace to compute direct light from this material. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.materials.<material name>.emission.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|-
|'''scene.materials.<material name>.emission.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.
|-
|'''scene.materials.<material name>.emission.theta''' || float || 90.0 || How directional the light is emitted, set as the half-angle of the light source. Default is 90°. Smaller values mean that more light is emitted in the direction of the face normals and less to the sides.
|-
|'''scene.materials.<material name>.emission.importance''' || float || 1.0 || A hint how often to sample this light source compared to other lights
|}

===Type: archglass===

This material should be used to replace glass material of windows when rendering architectural interiors. It allows direct light to pass trough.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "archglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: carpaint===

Car Paint is an advanced glossy material, simulating a diffuse surface with mutliple reflective coatings.

The available presets for the carpaint material are:

*"ford f8"
*"polaris silber"
*"opel titan"
*"bmw339"
*"2k acrylack"
*"white"
*"blue"
*"blue matte"

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "carpaint" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "ford f8" || one of the avilable presets
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || absorption color
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || absorption depth
|-
|'''scene.materials.<material name>.kd''' || texture || 0.0 0.0 0.0 || diffuse color
|-
|'''scene.materials.<material name>.ks1''' || texture || 0.0 0.0 0.0 || specular color - layer 1
|-
|'''scene.materials.<material name>.ks2''' || texture || 0.0 0.0 0.0 || specular color - layer 2
|-
|'''scene.materials.<material name>.ks3''' || texture || 0.0 0.0 0.0 || specular color - layer 3
|-
|'''scene.materials.<material name>.r1''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 1
|-
|'''scene.materials.<material name>.r2''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 2
|-
|'''scene.materials.<material name>.r3''' || texture || 0.0 0.0 0.0 || fresnel effect strength - layer 3
|-
|'''scene.materials.<material name>.m1''' || texture || 0.0 0.0 0.0 || roughness - layer 1
|-
|'''scene.materials.<material name>.m2''' || texture || 0.0 0.0 0.0 || roughness - layer 2
|-
|'''scene.materials.<material name>.m3''' || texture || 0.0 0.0 0.0 || roughness - layer 3
|}

===Type: cloth===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "cloth" || type of material
|-
|'''scene.materials.<material name>.preset''' || string || "denim" || denim, silk_charmeuse, silk_shantung, cotton_twill, wool_garbardine or polyester_lining_cloth
|-
|'''scene.materials.<material name>.weft_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in one weave direction
|-
|'''scene.materials.<material name>.weft_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in one weave direction
|-
|'''scene.materials.<material name>.warp_kd''' || texture || 0.5 0.5 0.5 || coefficient of diffuse reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.warp_ks''' || texture || 0.5 0.5 0.5 || coefficient of specular reflection in the opposite weave direction
|-
|'''scene.materials.<material name>.repeat_u''' || float || 100.0 || thread count in the u direction
|-
|'''scene.materials.<material name>.repeat_v''' || float || 100.0 || thread count in the v direction
|}

===Type: disney===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "disney" || type of material
|-
|'''scene.materials.<material name>.basecolor''' || texture || 0.5 0.5 0.5 || Base color
|-
|'''scene.materials.<material name>.subsurface''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.roughness''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.metallic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.specular''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.speculartint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoat''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.clearcoatgloss''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.anisotropic''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheen''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.sheentint''' || texture || 0.0 ||
|-
|'''scene.materials.<material name>.filmamount''' || texture || none || Linear interpolation between no film (0) and full film effect (1) for artistic control. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction (only for volume-less rendering)
|-
|'''scene.materials.<material name>.cauchyb''' || texture || 0.0 || if defined and > 0.0, enable dispersion. The value is the B term of the [https://en.wikipedia.org/wiki/Cauchy%27s_equation Cauchy's equation]
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: glossy2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossy2" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossytranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossytranslucent" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || texture or constant diffuse color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmission color of the material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.ks_bf''' || texture || 0.5 0.5 0.5 || texture or constant backface specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.uroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.vroughness_bf''' || texture || 0.1 || texture or constant backface roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.ka_bf''' || texture || 0.0 0.0 0.0 || texture or constant value of backface coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.d_bf''' || texture || 0.0 || texture or constant value of the backface depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.index_bf''' || texture || 0.0 0.0 0.0 || IOR of the backface coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|-
|'''scene.materials.<material name>.multibounce_bf''' || bool || false || backface simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: glossycoating===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "glossycoating" || type of material
|-
|'''scene.materials.<material name>.base''' || string || || name of base material, the coating layer is added on top of this material
|-
|'''scene.materials.<material name>.ks''' || texture || 0.5 0.5 0.5 || texture or constant specular color of the material
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.ka''' || texture || 0.0 0.0 0.0 || texture or constant value of coefficient of absorption of the coating layer
|-
|'''scene.materials.<material name>.d''' || texture || 0.0 || texture or constant value of the depth (thickness) of the coating layer for absorption effects. (0 = disables)
|-
|'''scene.materials.<material name>.index''' || texture || 0.0 0.0 0.0 || IOR of the coating. IOR overrides color Ks if both are specified
|-
|'''scene.materials.<material name>.multibounce''' || bool || false || simulation of asperity (velvet-like reflection) on the glossy surface
|}

===Type: matte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "matte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the matte material
|}

===Type: mattetranslucent===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mattetranslucent" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 0.5 0.5 0.5 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 0.5 0.5 0.5 || texture or constant transmitted color of the material
|}

===Type: metal2===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "metal2" || type of material
|-
|'''scene.materials.<material name>.fresnel''' || fresnel texture || ... || [[#Type:_Fresnel_Textures | fresnel texture]]
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.preset''' || string || "aluminium" || (DEPRECATED) "aluminium", "silver", "copper", "gold" or "amorphous carbon"
|-
|'''scene.materials.<material name>.n''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxn texture on overwrite the .preset property
|-
|'''scene.materials.<material name>.k''' || texture || 0.5 0.5 0.5 || (DEPRECATED) texture or constant value. It can be used to directly define a fresnelapproxk texture on overwrite the .preset property
|}

===Type: mirror===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mirror" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|}

===Type: mix===

This material can be used to mix 2 other materials.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "mix" || type of material
|-
|'''scene.materials.<material name>.material1''' || string || mat1 || name of another material
|-
|'''scene.materials.<material name>.material2''' || string || mat2 || name of another material
|-
|'''scene.materials.<material name>.amount''' || texture || 0.5 || texture or constant value used to mix the materials
|}

===Type: null===

This is empty, not visible material. It can be combined by using mix material with others. It is often used in combination with the alpha channel of an image map to render leafs, etc.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "null" || type of material
|}

===Type: roughglass===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughglass" || type of material
|-
|'''scene.materials.<material name>.kr''' || texture || 1.0 1.0 1.0 || texture or constant reflected color of the material
|-
|'''scene.materials.<material name>.kt''' || texture || 1.0 1.0 1.0 || texture or constant transmitted color of the material
|-
|'''scene.materials.<material name>.interiorior''' || texture || 1.5 || inside texture or constant index of refraction
|-
|'''scene.materials.<material name>.exteriorior''' || texture || 1.0 || outside texture or constant index of refraction
|-
|'''scene.materials.<material name>.uroughness''' || texture || 0.1 || texture or constant roughness value along u coordinate of the material
|-
|'''scene.materials.<material name>.vroughness''' || texture || 0.1 || texture or constant roughness value along v coordinate of the material
|-
|'''scene.materials.<material name>.filmthickness''' || texture || none || thickness (in nanometers) of a [https://en.wikipedia.org/wiki/Thin-film_interference thin-film coating] on the surface. This property is optional, if it is not defined, the coating is disabled.
|-
|'''scene.materials.<material name>.filmior''' || texture || none || Refractive index of the thin-film coating. This property is optional, if it is not defined, the coating is disabled.
|}

===Type: roughmatte===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "roughmatte" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.75 0.75 0.75 || texture or constant color of the roughmatte material
|-
|'''scene.materials.<material name>.sigma''' || texture || 0.0 || the sigma parameter in the Oren-Nayer shader in degrees. Zero for pure Lambertian reflection
|}

===Type: velvet===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.materials.<material name>.type''' || string || "velvet" || type of material
|-
|'''scene.materials.<material name>.kd''' || texture || 0.5 0.5 0.5 || color of the material's fuzz
|-
|'''scene.materials.<material name>.p1''' || texture || -2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p2''' || texture || 20.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.p3''' || texture || 2.0 || polynomial that influences the fuzz
|-
|'''scene.materials.<material name>.thickness''' || texture || 0.1 || height of the fuzz
|}

==Objects==

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.material''' || string || || type of object material
|-
|'''scene.objects.<object name>.shape''' || string || || name of [[#Shapes | shape]] with the triangle mesh description.Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same shape, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.ply''' || string || || '''(Deprecated, use .shape instead)''' name of [http://en.wikipedia.org/wiki/PLY_(file_format) PLY] file with the triangle mesh description. Memory required to store the triangle mesh information is allocated only once if 2 or more different objects share the same file, use .transformation property and true instancing is enabled.
|-
|'''scene.objects.<object name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.objects.<object name>.vertices''' || float || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of float values defining the vertices of the mesh (i.e. 3 coordinates for each vertex).
|-
|'''scene.objects.<object name>.faces''' || unsigned int || || This is an alternative syntax to using PLY file. It is an in-lined definition of the triangle mesh. It is a list of unsigned int values defining the triangles of the mesh (i.e. 3 index of vertices for each triangle).
|-
|'''scene.objects.<object name>.id''' || unsigned int || || object ID
|-
|'''scene.objects.<object name>.camerainvisible''' || bool || false || toggle visibility for camera rays. If set to true, the object will not show up in camera rays, but it will still be visible in reflections, refractions, shadows, indirect light etc.
|}

===Object Motion Blur===

LuxCore supports transformation motion blur for objects.
Motion blur is enabled if an object has a motion system defined as described below.

A motion system consists of steps (at least 2). Each step has a time (in seconds) and a transformation matrix of the object at this point in time.
Step indices start at 0. The times have to be monotonic (each greater than the last).

Note that the embree accelerator only supports a maximum of 129 time steps.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.objects.<object name>.motion.<step>.time''' || float || || time (in seconds) of the step
|-
|'''scene.objects.<object name>.motion.<step>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix of the object at the given step
|-
|}

==Shapes==

===Type: mesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "mesh" || mesh shape
|-
|'''scene.shapes.<shape name>.ply''' || string || ... || mesh path (e.g ''scenes/luxball/luxball-shell.ply'')
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: inlinedmesh===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "inlinedmesh" || inlinedmesh shape
|-
|'''scene.shapes.<shape name>.vertices''' || vector || ... || inlinedmesh vertices (e.g 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0 0.0)
|-
|'''scene.shapes.<shape name>.faces''' || vector || ... || inlinedmesh faces (e.g 0 1 2)
|-
|'''scene.shapes.<shape name>.appliedtransformation''' || Matrix4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0|| transformation matrix applied to the mesh vertices. Used to define the local object reference space.
|}

===Type: pointiness===

Contains surface curvature information in vertex alpha channel. 
You can access this information in materials via a hitpointalpha texture. 
The values range from -1 to 1 (float). 
Values from -1 to 0 are concave, while values from 0 to 1 are convex.

[[ Shape:_Pointiness | Examples ]]

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "pointiness" || pointiness shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || pointiness source (a mesh shape)
|}

===Type: strands===

Can be used for hair, fur, grass etc. 
Note that you need to define the camera before defining any strands shapes, because the tesselation process is viewpoint-dependent.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "strands" || strands shape
|-
|'''scene.shapes.<shape name>.file''' || string || ... || strands file (''scenes/strands/straight.hair'')
|}

====Strands tessellation methods====

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbon" || ribbon tessellation
|-
|'''scene.shapes.<shape name>.tessellation.usecameraposition''' || bool || 1 || use camera position
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "ribbonadaptive" || ribbon adaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.maxdepth''' || unsigned int || 12 || max tessellation depth
|-
|'''scene.shapes.<shape name>.tessellation.adaptative.error ''' || float || 0.0075 || max tessellation error
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solid" || solid tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solid.sidecount ''' || unsigned int || 12 || tessellation's side count
|}

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.tessellation.type''' || string || "solidadaptive" || solidadaptive tessellation method
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.sidecount ''' || unsigned int || 8 || tessellation's side count
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.maxdepth''' || unsigned int || 16 || tessellation's max depth
|-
|'''scene.shapes.<shape name>.tessellation.solidadaptive.error''' || float || 0.05 || tessellation's max error
|}

===Type: group===

Todo.

===Type: displacement===

Todo.

===Type: subdiv===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.shapes.<shape name>.type''' || string || "subdiv" || subdivided shape
|-
|'''scene.shapes.<shape name>.source''' || string || ... || source mesh name
|-
|'''scene.shapes.<shape name>.maxlevel''' || unsigned integer || 2 || maximum level of subdivision
|-
|'''scene.shapes.<shape name>.maxedgescreensize''' || float || 0.0 || maximum edge screen size
|-
|'''scene.shapes.<shape name>.adaptive''' || bool || 1 || Adaptive refinement / Uniform refinement
|}

===Type: harlequin===

Todo.

===Type: simplify===

Todo.

===Type: islandaov===

Todo.

===Type: randomtriangleaov===

Todo.

==Light sources==

Check [[Lighting|LuxCoreRender Lighting]] for an high level description and example of the light sources.

===Common parameters===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.gain''' || spectrum || 1.0 1.0 1.0 || intensity of the light
|-
|'''scene.lights.<light name>.transformation''' || matrix 4x4 || 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 0.0 1.0 || transformation matrix
|-
|'''scene.lights.<light name>.samples''' || int || -1 || the number of shadow ray to trace to compute direct light for this light source. This property is an hint and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.id''' || int || 0 || the radiance group the light emitted from this material is assigned to.

|-
|'''scene.lights.<light name>.importance''' || float || 1.0 || A hint how often to sample this light compared to other lights
|}

===Type: sun===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sun" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.relsize''' || float || 1.0 || relative size to the sun
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sky2===

Hosek-Wilkie sky model.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sky2" || type of light
|-
|'''scene.lights.<light name>.turbidity''' || float || 2.2 || turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days
|-
|'''scene.lights.<light name>.dir''' || vector || 0.0 0.0 1.0 || direction vector of the sun
|-
|'''scene.lights.<light name>.gain''' || vector || ... || gain
|-
|'''scene.lights.<light name>.groundalbedo''' || vector || 0.5 0.5 0.5 || ground albedo
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.ground.enable''' || bool || 1 || enable ground color
|-
|'''scene.lights.<light name>.ground.color''' || vector|| ... || RGB ground color
|}

===Type: infinite===

Spherical lightsource surrounding the scene at infinite distance. 
Used for image based lighting (IBL) and HDR environment lighting if the file is a high dynamic range image.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "infinite" || type of light
|-
|'''scene.lights.<light name>.file''' || string || "image.png" || filename of the environment map
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma correction used by the image map
|-
|'''scene.lights.<light name>.storage''' || string || "auto" || environment map storage type ("auto", "byte", "half" or "float")
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.sampleupperhemisphereonly''' || bool || false || an option set to black the lower hemisphere. Mostly useful for shadow catchers.
|}

===Type: point===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "point" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mappoint===

Point light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mappoint" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: sphere===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|}

===Type: mapsphere===

Sphere light with support for IES files or image maps controlling the strength of light emitted.

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "mapsphere" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.radius''' || float || 1.0 || position
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.mapfile''' || string || || the name of an optional image map that can be used to scale the emitted light
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|-
|'''scene.lights.<light name>.iesfile''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light and the render engine can ignore this information. -1 means use the default global value.
|-
|'''scene.lights.<light name>.iesblob''' || string || || a [http://en.wikipedia.org/wiki/Illuminating_Engineering_Society_of_North_America IES] profile of emitted light embedded in a blob
|-
|'''scene.lights.<light name>.flipz''' || bool || false || flip the IES profile along the Z axis
|-
|'''scene.lights.<light name>.map.width''' || unsigned int || 0 || scale the image or IES map to the specified width. 0 means use the original size
|-
|'''scene.lights.<light name>.map.height''' || unsigned int || 0 || scale the image or IES map to the specified height. 0 means use the original size
|}

===Type: spot===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "spot" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.coneangle''' || float || 30.0 || angle in degrees of the spotlight cone
|-
|'''scene.lights.<light name>.conedeltaangle''' || float || 5.0 || angle at which the spotlight intensity starts to fade from the edge
|}

===Type: projection===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "projection" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.fov''' || float || 45.0 || field of view in terms of angular spread along the shorter image axis
|-
|'''scene.lights.<light name>.mapfile''' || string || || filename of the image to project. If not specified, a constat light color will be used.
|-
|'''scene.lights.<light name>.gamma''' || float || 2.2 || gamma value of the image map defined with .mapfile property
|}

===Type: constantinfinite===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "constantinfinite" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.visibility.indirect.diffuse.enable''' || bool || true || if the light source is visible by indirect rays on diffuse surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.glossy.enable''' || bool || true || if the light source is visible by indirect rays on glossy surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|-
|'''scene.lights.<light name>.visibility.indirect.specular.enable''' || bool || true || if the light source is visible by indirect rays on specular surfaces. This is an hint and can be optional supported by the render engine. It can be used to remove fireflies.
|}

===Type: sharpdistant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "sharpdistant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|}

===Type: distant===

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "distant" || type of light
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.direction''' || vector || 0.0 0.0 1.0 || direction
|-
|'''scene.lights.<light name>.theta''' || float || 10.0 || half angle of the light source in degree. Must be > 0 for soft shadows
|}

===Type: laser===

A light source emitting parallel light rays (like sharpdistant light, but starting inside the scene instead of infinitely far away).

{| class="wikitable" cellspacing="2"
!Property name
!Property type
!Default value
!Description
|-
|'''scene.lights.<light name>.type''' || string || "laser" || type of light
|-
|'''scene.lights.<light name>.position''' || point || 0.0 0.0 0.0 || position
|-
|'''scene.lights.<light name>.target''' || point || 0.0 0.0 1.0 || target
|-
|'''scene.lights.<light name>.color''' || spectrum || 1.0 1.0 1.0 || color
|-
|'''scene.lights.<light name>.power''' || float || 0.0 || lamp output power in watts. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.efficency''' || float || 0.0 || luminous efficacy in lumens/watt. Setting 0 for both power and efficacy bypasses this feature and uses only the lamp gain
|-
|'''scene.lights.<light name>.radius''' || float || 0.01 || radius of the laser beam
|}

LuxCoreRender Release Notes v2.11

2026-06-06T14:31:40Z

CodeHD: /* LuxCore */

= BlendLuxCore =
'''Coding/Backend'''
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* Use LuxCore internal OIDN (rather than embedding and calling an external OIDN executable)

'''Bugfix'''
* Added a workaround for a Blender bug that throws an error when Blender is closed https://projects.blender.org/blender/blender/issues/140488
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Fix rounding of convergence percentage, reaching 100% to early for complex scenes
* Fix Blender crash when clicking Copy Material

'''Features (of interest for users)'''
* Update compatibility for Blender 5.0
* Fresnel texture: "custom n,k" now accepts values > 1
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space (c.f. section LuxCore)
* New shape node "MergeOnDistance" (like Blender Merge by Distance)
* Subdiv: (simple) crease management

= BlendLuxHelper =
* Adding BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel that is imported by BlendLuxCore.
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked within the scope of BlendLuxHelper)
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)

= LuxCore =

'''Coding/Backend'''
* Subdivision: multithreaded version, in order to improve speed
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Adapt CI pipelines to MacOS-15 runners (after deprecation of MacOS-13 runners on Github)
* Remove direct access to Blender internal objects. Use Blender API instead, more stable.
* Add support for Python 3.14 (and remove support for 3.9)

'''Bugfix'''
* Fix a bug leading to unstable brightness between renderings when using saved crashes (Credit to FELIX Render developers)
* Fix volume evaluation in BiDir engine https://github.com/LuxCoreRender/LuxCore/issues/647
* Fix various bugs when using orthographic camera with light tracing https://github.com/LuxCoreRender/LuxCore/issues/667
* Fix various memory-related issues (leaks, potential access violations...). Modernize memory handling (to be continued)
* Avoid crash if no OpenCL and/or Nvidia API is found
* Fix several race conditions
* Fixed an error where paused renderings can't be stopped anymore
* 3D-mapping: Fix inconsistent behavior between local and random-local mapping https://github.com/LuxCoreRender/BlendLuxCore/issues/656
* Add a clamping in SchlickBSDF to avoid (very small) floating point issues

'''Features (of interest for users)'''
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Make `pyluxcoretools` available again (in the wheels)
* Apply the behavior of the BiDir engine w.r.t. shadow color mechanism to Path+Light tracing. Breaking change for scenes using shadow color and light tracing (not BiDir)! https://github.com/LuxCoreRender/LuxCore/issues/671
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space https://github.com/LuxCoreRender/BlendLuxCore/issues/644

= LuxCoreDeps =
* Dependencies updated to latest versions
* Better dependency pinning (for nvrtc and conan-index)
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

LuxCoreRender Release Notes v2.11

2026-06-06T14:24:28Z

CodeHD: minor title change

= BlendLuxCore =
'''Coding/Backend'''
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* Use LuxCore internal OIDN (rather than embedding and calling an external OIDN executable)

'''Bugfix'''
* Added a workaround for a Blender bug that throws an error when Blender is closed https://projects.blender.org/blender/blender/issues/140488
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Fix rounding of convergence percentage, reaching 100% to early for complex scenes
* Fix Blender crash when clicking Copy Material

'''Features (of interest for users)'''
* Update compatibility for Blender 5.0
* Fresnel texture: "custom n,k" now accepts values > 1
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space (c.f. section LuxCore)
* New shape node "MergeOnDistance" (like Blender Merge by Distance)
* Subdiv: (simple) crease management

= BlendLuxHelper =
* Adding BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel that is imported by BlendLuxCore.
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked within the scope of BlendLuxHelper)
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)

= LuxCore =

'''Coding/Backend'''
* Subdivision: multithreaded version, in order to improve speed
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Adapt CI pipelines to MacOS-15 runners (after deprecation of MacOS-13 runners on Github)
* Remove direct access to Blender internal objects. Use Blender API instead, more stable.
* Add support for Python 3.14 (and remove support for 3.9)

'''Bugfix'''
* Fix a bug leading to unstable brightness between renderings when using saved crashes (Credit to FELIX Render developers)
* Fix volume evaluation in BiDir engine https://github.com/LuxCoreRender/LuxCore/issues/647
* Fix various bugs when using orthographic camera with light tracing https://github.com/LuxCoreRender/LuxCore/issues/667
* Fix various memory-related issues (leaks, potential access violations...). Modernize memory handling (to be continued)
* Avoid crash if no OpenCL and/or Nvidia API is found
* Fix several race conditions
* Fixed an error where paused renderings can't be stopped anymore
* 3D-mapping: Fix inconsistent behavior between local and random-local mapping https://github.com/LuxCoreRender/BlendLuxCore/issues/656

'''Features (of interest for users)'''
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Make `pyluxcoretools` available again (in the wheels)
* Apply the behavior of the BiDir engine w.r.t. shadow color mechanism to Path+Light tracing. Breaking change for scenes using shadow color and light tracing (not BiDir)! https://github.com/LuxCoreRender/LuxCore/issues/671
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space https://github.com/LuxCoreRender/BlendLuxCore/issues/644

= LuxCoreDeps =
* Dependencies updated to latest versions
* Better dependency pinning (for nvrtc and conan-index)
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

Deploying LuxCoreRender

2026-05-05T20:31:11Z

CodeHD: /* Documentation and Announcements */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each): the space required for one release is about 1.5GB. As a consequence, the space sufficiency must be checked each time a version has to be deployed.

Nota: this check is critical and should be done with care. If the upload to PyPI is interrupted halfway, for instance by lack of space, the version number will still become no more available.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* Ensure the change log is available
* Define and check Release Version Numbers (one for LuxCore and one for BlendLuxCore): they should have been neither allocated before, and the LuxCore should not have been used on PyPI.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the targeted version number for LuxCore.

* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: checked

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: checked
This will upload the wheels to PyPI test (deployment - test).
This is a test step, to check everything is fine before uploadig to real PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* In <code>luxloader/__init__.py</code>, set <code>PYLUXCORE_VERSION</code> to the version of related <code>pyluxcore</code>. The version to use must be strictly the same as the one that appears on PyPI. Please check syntax carefully, as PyPI may slightly modify version number when uploading.

* In <code>blender_manifest.toml</code>, set <code>version</code> parameter to the targeted version of BLC. Caveat: this version can differ from pyluxcore version defined above.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Documentation and Announcements ==

Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.
Furthermore, the final step after release and deployment is to announce the release to the community.

The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:
* This wiki, particularly
** Release notes
** FAQ entries
** Updates to the build process
** Description of new features, API and SDL documentation
* The project website
** particularly the downloads section
* The README files in all active code repositories
* The AUTHORS file and credits list
** specifically regarding 3rd-party modules that may have been added to the code
* Announcement on the forums
* Announcement in the discord channel
* Announcement on Blenderartist, ...

During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.

==== Alpha ====
* Update the release notes
* Update the API/SDL description
* Check the authors file and credits list
* Brief GitHub release notes with warning labels about stability
* Announcement on the most active user channels
* Decide on final tasks/known bugs that shall be fixed during alpha/beta phase

==== Beta ====
* Keep updating release notes and API/SDL documentation
* Update the Readme files in the code base
* Start preparing a summary release notes for the GitHub release
* Announcement of beta phase on more community channels
* Complete all tasks for features/known bugfixes

==== Release Candidate ====
* All documentation shall be updated fully
* Update FAQs with feedback from alpha/beta phase
* Double check authors and credits
* GitHub release notes still should contain a warning label
* Start preparing stable release announcement messages for all channels

==== Stable (X.Y.0) ====
* Double-check all documentation
* Prepare the final release notes summary
* Create the release
* Update the download section on the website
* Create the announcement post on the forums
* Finally, announce on Discord and optionally other sites

==== Bugfix (X.Y.Z) ====
For bugfix releases, prepare the following
* Update the Release Notes on this wiki
* Prepare a summary release notes targeted at users
** This needs to only include the incremental changes from the previous version
* Make a short announcement on the same channels as the for the stable release

Deploying LuxCoreRender

2026-05-05T20:30:54Z

CodeHD: /* Documentation and Announcements */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each): the space required for one release is about 1.5GB. As a consequence, the space sufficiency must be checked each time a version has to be deployed.

Nota: this check is critical and should be done with care. If the upload to PyPI is interrupted halfway, for instance by lack of space, the version number will still become no more available.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* Ensure the change log is available
* Define and check Release Version Numbers (one for LuxCore and one for BlendLuxCore): they should have been neither allocated before, and the LuxCore should not have been used on PyPI.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the targeted version number for LuxCore.

* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: checked

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: checked
This will upload the wheels to PyPI test (deployment - test).
This is a test step, to check everything is fine before uploadig to real PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* In <code>luxloader/__init__.py</code>, set <code>PYLUXCORE_VERSION</code> to the version of related <code>pyluxcore</code>. The version to use must be strictly the same as the one that appears on PyPI. Please check syntax carefully, as PyPI may slightly modify version number when uploading.

* In <code>blender_manifest.toml</code>, set <code>version</code> parameter to the targeted version of BLC. Caveat: this version can differ from pyluxcore version defined above.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Documentation and Announcements ==
'''THIS SECTION IS WORK IN PROGRESS (CodeHD, 23.04.2026)'''

Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.
Furthermore, the final step after release and deployment is to announce the release to the community.

The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:
* This wiki, particularly
** Release notes
** FAQ entries
** Updates to the build process
** Description of new features, API and SDL documentation
* The project website
** particularly the downloads section
* The README files in all active code repositories
* The AUTHORS file and credits list
** specifically regarding 3rd-party modules that may have been added to the code
* Announcement on the forums
* Announcement in the discord channel
* Announcement on Blenderartist, ...

During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.

==== Alpha ====
* Update the release notes
* Update the API/SDL description
* Check the authors file and credits list
* Brief GitHub release notes with warning labels about stability
* Announcement on the most active user channels
* Decide on final tasks/known bugs that shall be fixed during alpha/beta phase

==== Beta ====
* Keep updating release notes and API/SDL documentation
* Update the Readme files in the code base
* Start preparing a summary release notes for the GitHub release
* Announcement of beta phase on more community channels
* Complete all tasks for features/known bugfixes

==== Release Candidate ====
* All documentation shall be updated fully
* Update FAQs with feedback from alpha/beta phase
* Double check authors and credits
* GitHub release notes still should contain a warning label
* Start preparing stable release announcement messages for all channels

==== Stable (X.Y.0) ====
* Double-check all documentation
* Prepare the final release notes summary
* Create the release
* Update the download section on the website
* Create the announcement post on the forums
* Finally, announce on Discord and optionally other sites

==== Bugfix (X.Y.Z) ====
For bugfix releases, prepare the following
* Update the Release Notes on this wiki
* Prepare a summary release notes targeted at users
** This needs to only include the incremental changes from the previous version
* Make a short announcement on the same channels as the for the stable release

Deploying LuxCoreRender

2026-04-23T18:21:13Z

CodeHD: /* Announcements */

= Audience, Definitions and Scope =

This document is intended for LuxCoreRender administrators only.

The process requires that the administrator running Release and Deploy be:
* granted with sufficient rights on LuxCoreRender repositories on Github, including running actions, producing releases etc.
* granted with sufficient rights on LuxCoreRender repository on PyPI and PyPI-test, including adding and deleting versions
* skilled enough in Github administration and, especially, able to run Github actions
* and skilled enough in PyPI administration
Please check that you meet these criteria before reading further.

In this document:
* Releasing refers to the process of finalizing a version of LuxCore, i.e. defining a state of LuxCore which can be made available to end-users.
* Deployment refers to the process of making a new release of LuxCoreRender available to end-users.

The scope of Deployment includes the following components:
* Python Wheels (aka <code>pyluxcore</code>)
* Samples (aka <code>luxcoreui</code> and <code>luxcoreconsole</code>)
* BlendLuxCore

Please note we deliberately exclude the dependencies (aka <code>LuxCoreDeps</code>) from the deployment scope. Indeed:
* Dependencies are not intended for end-users, so deployment is not applicable.
* Up-to-date dependencies are necessary for LuxCore development and tests, so they should have been released for a while when LuxCore deployment occurs.

= Prequisites =

== Clean Branches ==

The procedure assumes the releases can be created from the default branches in each repository, namely (2026-04-19):
* <code>master</code> for LuxCore
* <code>main</code> for BlendLuxCore
Please check the above branches contain all the history you target for your releases and, if not, please make the required git plumbing.

== LuxCore Buildability ==

The procedure requires that targeted LuxCore components be buildable by Continuous Integration.

This can be checked by running the following Github Actions:
* Wheels: <code>LuxCore Python Wheel Builder</code> (in LuxCore repository)
* Samples: <code>LuxCore Python Sample Builder</code> (in LuxCore repository)
* BlendLuxCore: <code>BlendLuxCore Build Bundle</code> (in BlendLuxCore)

Please check the components meet those requirements before any Release/Deploy task is engaged.

== Change Log readiness ==

At a certain point in the process, a change log will be expected: you should have prepared it beforehand. Note this can be done afterwards, however.

== Consistent Version Numbers ==
First, note you'll need 2 version numbers:
* One for LuxCore
* One for BlendLuxCore
There is no reason why these 2 version numbers should be the same.

These version numbers must enforce Semantic Versioning, as stated in [[Building_LuxCoreRender | Building LuxCoreRender]]

Please note also that the version numbers should not have been used in anyway in previous releases. It is particularly important for PyPI (and PyPI-test), that will reject any upload declaring a version that has already been in use before, event for a short time.

== Sufficient space on PyPI and PyPI-test ==

The space on PyPI and PyPI-test is limited to 10GB (as of now, 2026-04-19).

At first glance, this could look quite comfortable, however we release 20 wheels each time (about 80-100MB each): the space required for one release is about 1.5GB. As a consequence, the space sufficiency must be checked each time a version has to be deployed.

Nota: this check is critical and should be done with care. If the upload to PyPI is interrupted halfway, for instance by lack of space, the version number will still become no more available.

= Procedure =

== Pre-Flight Review ==
As stated above, before starting the core procedure, carry out the following actions:

* Ensure the default branches are up-to-date
* Check LuxCore buildability: run the 3 actions listed above.
* Ensure the change log is available
* Define and check Release Version Numbers (one for LuxCore and one for BlendLuxCore): they should have been neither allocated before, and the LuxCore should not have been used on PyPI.
* Check the space on PyPI and PyPI-test. If not sufficient, clean oldest versions.

Afterwards, you are ready to start the core process.

== Wheels Release and Deployment ==

* Set the <code>version</code> parameter in <code>build-system/conan/conanfile.py</code> to the targeted version number for LuxCore.

* Run action <code>LuxCore Python Wheels Releaser</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: checked

This will build the wheels and create a release in draft mode.

* Open the draft release and set its status to <code>prerelease</code> or <code>latest release</code>. Also, insert the change log in the release text. Save the release.

At this stage, the wheels are released, but we still have to deploy them through PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: checked
This will upload the wheels to PyPI test (deployment - test).
This is a test step, to check everything is fine before uploadig to real PyPI.

* Run action <code>LuxCore Python Wheels Publisher</code>, with the following settings:
Branch: <code>master</code>
Version: the version number you selected before
Run on PyPI test: unchecked
This will upload the wheels to PyPI (deployment).

At this stage, if everything succeeded, wheels are available for any user, with <code>pip install pyluxcore == <version> </code>. You may want to test and/or have a look on PyPI.

== Samples Release and Deployment ==

Nota #1: This step should be skipped for alpha releases, as the vast majority of alpha testers use Blender for testing. No need for samples in this context...

Nota #2: We assume the wheels have just been released, so that it is possible to reuse their build artifacts. This will be done by clearing 'rebuild all' in the following action.

* Run Github action named <code>LuxCore Samples Releaser</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): unchecked
Rebuild all: unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== BlendLuxCore Release and Deployment ==

Important warning: BLC should not be released while related wheels have not been deployed yet. Indeed, <code>pyluxcore</code> version must be known before starting any release or deploy action of BLC.Once that requirement is met:

* In <code>luxloader/__init__.py</code>, set <code>PYLUXCORE_VERSION</code> to the version of related <code>pyluxcore</code>. The version to use must be strictly the same as the one that appears on PyPI. Please check syntax carefully, as PyPI may slightly modify version number when uploading.

* In <code>blender_manifest.toml</code>, set <code>version</code> parameter to the targeted version of BLC. Caveat: this version can differ from pyluxcore version defined above.

* Commit your changes and push to BlendLuxCore repository, if needed.

* Run Github action named <code>BlendLuxCore Create Release</code>, with the following settings:
Branch: main
Version: the version number you selected before
Update existing release (if any): Unchecked

At this stage, a draft release should have been created.

* Open the draft release, insert change log and set release status to <code>prerelease</code> or <code>latest release</code>.

* For latest releases, publish the files on the website

== Documentation and Announcements ==
'''THIS SECTION IS WORK IN PROGRESS (CodeHD, 23.04.2026)'''

Part of the process of releasing a software is to create a proper documentation, both to support future development and to provide users with the necessary information to work efficiently with the software.
Furthermore, the final step after release and deployment is to announce the release to the communicate.

The following items are currently - as of v2.11 - particularly important and should be checked and well considered before a final release:
* This wiki
** particularly the pages linked on the front page
* The project website
** particularly the downloads section
* The README files in all active code repositories
* The AUTHORS file and credits list
** specifically regarding 3rd-party modules that may have been added to the code
* Announcement on the forums
* Announcement in the discord channel
* Announcement on Blenderartist

During the various release steps (alpha, beta, release candidate, stable and subsequent bugfixes), the different items may be completed to varying degrees, reaching maturity towards the stable release. The following are suggestions based on past experience. You can always look at past releases for inspiration.

==== Alpha ====

==== Beta ====

==== Release Candidate ====

==== Stable (X.Y.0) ====
At this point, all

==== Bugfix (X.Y.Z) ====
For bugfix releases, prepare the following
* Update the Release Notes on this wiki
* Prepare a summary release notes targeted at users
** This needs to only include the incremental changes from the previous version
* Make a short announcement on the same channels as the Stable release

BlendLuxCore FAQ

2026-04-11T10:21:03Z

CodeHD: /* I can not enable the BlendLuxCore addon, it shows errors */

= Frequently Asked Questions =

=== When trying to use CUDA/OptiX, Blender crashes ===

This can be a different manifestation of the issue described below (CUDA_ERROR_UNSUPPORTED_PTX_VERSION). Try to upgrade the nvidia driver to the latest version, or try the studio driver branches for a latest stable version.

Specifically, this has been observed with nvrtc13 in combination with drivers <590.

=== When trying to use CUDA/OptiX, I get the error message: <code>RUNTIME ERROR: CUDA driver API error CUDA_ERROR_UNSUPPORTED_PTX_VERSION (code: 222, file:.../cuda.cpp, line: xxx): the provided PTX was compiled with an unsupported toolchain.</code> ===

Your nvidia driver is too old compared to nvidia runtime compiler used by LuxCore, so the code compiled by LuxCore runtime compiler cannot be run by your driver.

Please upgrade your nvidia driver to latest version, or at least to a suitable version with regard to runtime compiler: https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html#id7

=== After installation, I get the error message "could not import pyluxcore" ===

"pyluxcore" is the binary core library. BlendLuxCore downloads and installs the correct version for your system during installation. This error indicates something went wrong with this installation. Possible solutions are:
* Check that online access is allowed in the Blender preferences.
* Download may be restricted in company networks. You can try an [https://wiki.luxcorerender.org/BlendLuxCore_Installation#Offline_Installation offline-installation].

=== I can not enable the BlendLuxCore addon, it shows errors ===

'''Note: This section applies to older BlendLuxCore versions up to v2.9alpha'''

Most problems in this area stem from broken graphics driver installations. Try to re-install or update your graphics driver.

'''For Windows users:'''
* Make sure that you have installed the [https://www.microsoft.com/en-US/download/details.aspx?id=40784 Visual C++ Redistributable Packages for Visual Studio 2013]
* If you use v2.1alpha0 or later, you will also need:
** [https://aka.ms/vs/15/release/vc_redist.x64.exe Microsoft Visual C++ Redistributable for Visual Studio 2017]
** [https://software.intel.com/sites/default/files/managed/59/aa/ww_icl_redist_msi_2018.3.210.zip Intel C++ redistributable]

If this does not solve the problem, browse the [https://github.com/LuxCoreRender/BlendLuxCore/issues?q=is%3Aissue+label%3Ainstallation installation issues] in the bug tracker to check if your error message was already reported.
If it was not reported yet, open a new issue and copy the error message from the Blender console (on Windows, click Window -> Toggle System Console in Blender's menu. On Linux, start Blender from a terminal and try to enable the addon, then copy the error message from the terminal).

See the [[BlendLuxCore_Installation | installation page]] for information on how to install, update and remove the BlendLuxCore addon.

=== Is there something like Cycles' Layer Weight/Fresnel/Facing node in LuxCore? ===

No, in LuxCore there is no direct equivalent to this node, because it would not work with the many algorithms in LuxCore that trace rays from lights (instead of from the camera), like the bidirectional engine, light tracing mode, or the PhotonGI cache.

Of course, all materials in LuxCore are physically based and have realistic fresnel effects built-in.

You can achieve a similar effect with the dot product node, but it will work only for one viewpoint:

[[File:Layer_weight_for_one_direction.PNG | thumb | 400px | center]]

=== Can Cycles materials be used in BlendLuxCore? ===

To an extent, yes. Many common Cycles shader nodes can be used in BlendLuxCore:

* You can enable this individually for each material with the "Use Cycles Nodes" option in the material properties.
* You can also enable it for the whole scene at once with the "Use Cycles Settings" button in the render properties. This will configure all materials, lights and the world to use Cycles settings

Not all Cycles nodes and settings are supported. Here is an overview: https://github.com/LuxCoreRender/BlendLuxCore/issues/272

=== Can 2D/3D mapping be driven by textures in LuxCore? ===

In general, no, because it would lead to much worse performance on GPUs.

However, if you only need to drive the translation part of a texture mapping, since LuxCore v2.5 you can use the distort texture for this purpose:

[[File:Distort_texture.PNG | thumb | 400px | center | A checker texture (left) is distorted by a clouds texture (right). The result can be seen in the center]]

Texturing of rotation and scale is not yet possible.

=== What can be done against fireflies/hotpixels? ===

Sometimes, pixels appear that are much brighter than the surrounding pixels. Sometimes they are singular, sometimes clumped up. The underlying reason are light paths that are correct, but very hard to find with the current rendering algorithms, and thus they take much longer to render until noise-free than all other light paths in the image.

There are multiple ways to approach this problem:

* '''Try another rendering algorithm''', it might be able to find the firefly-causing light paths much easier than the one you currently use. For example, try going to the render properties, open the Light Paths panel and enable "Light Tracing", or try the [[PhotonGI | PhotonGI caustic cache]], or try using the bidirectional engine.
* You can '''clamp the brightness of all light paths''' to a maximum value, in the render properties, Light Paths panel, "Clamping" setting. BlendLuxCore can auto-detect a value for this setting that is in the right ballpark for your scene if you render once without clamping enabled, but often this value will not be the best, so you will need a bit of trial-and-error to find a good value. Note that the clamping value depends on the lighting in your scene, so there is no one universally good clamping value, and you might need to adjust it if you add a new light source to your scene that is brighter than the others. Using a clamping value that is too low will result in a low-contrast, washed-out image, while a too high value will leave fireflies unaffected.
* Try to find out which lights or materials are responsible for the fireflies. There might be small, hard-to-find light sources that are causing them. Or a specular material is reflecting such a light source. If you are willing to alter the look of the scene, you can make such a light source more visible/larger, or lower the specularity of such a material. You can also make some light sources invisble to indirect light rays, thus eliminating fireflies (light properties, "Visibility" panel). This can be a good idea for the sun, for example, if your scene contains lots of specular materials.

=== Why is my HDRI environment black and not showing up? ===
You probably have other very bright light sources in the scene, for example a sun or a sky lamp.

'''Solution:''' raise the gain value of the area or HDRI light source that is black. The gain value might need to be very high, e.g. 100000.

=== Why is my area lamp black? ===
See [[#"Why is my HDRI environment black and not showing up?"]]

=== When I change the brightness of my lamp, nothing happens ===

You are probably using an automatic tonemapper which adjusts itself to the changed brightness, making it seem like the brightness did not change.

'''Solution:''' Use a non-automatic tonemapper (camera settings -> [[ImagePipeline]]).


=== When I make one of my lights brighter, all the other lights get darker (or vice versa) ===

Similar to [[#"When I change the brightness of my lamp, nothing happens"]]. 
You are using an automatic tonemapper which tries to keep the image at the same brightness, making it seem like the brightness of the lamps changed.

'''Solution:''' Use a non-automatic tonemapper (camera settings -> [[ImagePipeline]]).


=== A material/object appears to be flickering when I move the camera and shows artifacts in final render ===

This effect is called [https://en.wikipedia.org/wiki/Z-fighting Z-fighting] and is usually caused by mesh faces being exactly on top of each other, e.g. two planes on the same world coordinates.

'''Solution:'''
* Check if there are two objects on top of each other, e.g. because you duplicated the object, cancelled the transform and forgot about it.
* Check if the mesh has duplicate faces. Enter edit mode and use the Remove Doubles button in the Tools panel, which might solve the problem in some cases.
Duplicate faces are often caused by extruding, cancelling the transform and forgetting about it.

=== There are dark triangular artifacts on my model, and I already checked for duplicate faces ===

Floating point numbers have a limited precision. When objects are very large (kilometers) or very small (micrometers), these precision issues become visible.

'''Solution:'''
* If the object has a "normal" size (something like 1 cm to 1 km), but was scaled up/down by a huge amount, try to apply the scale (Ctrl+A -> Scale). For example, this often happens with imported CAD models.
* If applying the scale did not help and your object has to be very small or large, consider to bring it into the normal scale mentioned above, and pretend that it has a larger/smaller size. For example, if you make a model of the solar system, you will just have to make the earth something like 12.742 m in diameter, and pretend that 1 m of your model is equal to 10^6 m.
* If both options above are not usable in your case, you can raise the minimum epsilon that LuxCore uses. This setting can be found in the scene properties, Units panel, after clicking "Advanced LuxCore Settings". By default, the minimum epsilon is 0.00001. Try to raise it to 0.0001 (multiply by 10) for a start and see if the artifacts disappear. Do not set this value higher than necessary, because it will cause all sorts of hard-to-track problems. Be especially careful if you are rendering a scene with volumes.

=== An object that I set to "smooth shading" looks like it is shaded flat in shadow penumbras ===

This artifact is called "terminator problem".

'''Solution:''' Unfortunately there is no real solution. You can only try to mitigate the effect by subdividing the geometry further and/or increase the size of the light source that is causing the problem.

=== How do I setup liquid in a glass container correctly? ===

This forum thread shows an example: https://forums.luxcorerender.org/viewtopic.php?f=4&t=728#p7550

=== Can I export my scene in LuxCore format to render it in LuxCore standalone? ===

Yes. In the render properties, LuxCore Tools panel, enable "FileSaver". Then render with F12.

=== How can I compile kernels from the command line? ===
Here is a way to compile kernels from the command line (out of Blender), for the latest version of pyluxcore:
<pre>
pip install pyluxcore --upgrade
python -c "import pyluxcore; pyluxcore.Init(); pyluxcore.KernelCacheFill()"
</pre>

= Getting Help =

If none of the above entries helped to solve your problem, consider asking in the [https://forums.luxcorerender.org/viewforum.php?f=4 user support forum] or [https://forums.luxcorerender.org/viewtopic.php?f=4&t=2 filing a bug report].

[[Category:BlendLuxCore]]

BlendLuxCore FAQ

2026-04-11T10:19:04Z

CodeHD: Add a new section about CUDA/OptiX

= Frequently Asked Questions =

=== When trying to use CUDA/OptiX, Blender crashes ===

This can be a different manifestation of the issue described below (CUDA_ERROR_UNSUPPORTED_PTX_VERSION). Try to upgrade the nvidia driver to the latest version, or try the studio driver branches for a latest stable version.

Specifically, this has been observed with nvrtc13 in combination with drivers <590.

=== When trying to use CUDA/OptiX, I get the error message: <code>RUNTIME ERROR: CUDA driver API error CUDA_ERROR_UNSUPPORTED_PTX_VERSION (code: 222, file:.../cuda.cpp, line: xxx): the provided PTX was compiled with an unsupported toolchain.</code> ===

Your nvidia driver is too old compared to nvidia runtime compiler used by LuxCore, so the code compiled by LuxCore runtime compiler cannot be run by your driver.

Please upgrade your nvidia driver to latest version, or at least to a suitable version with regard to runtime compiler: https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html#id7

=== After installation, I get the error message "could not import pyluxcore" ===

"pyluxcore" is the binary core library. BlendLuxCore downloads and installs the correct version for your system during installation. This error indicates something went wrong with this installation. Possible solutions are:
* Check that online access is allowed in the Blender preferences.
* Download may be restricted in company networks. You can try an [https://wiki.luxcorerender.org/BlendLuxCore_Installation#Offline_Installation offline-installation].

=== I can not enable the BlendLuxCore addon, it shows errors ===

Most problems in this area stem from broken graphics driver installations. Try to re-install or update your graphics driver.

'''For Windows users:'''
* Make sure that you have installed the [https://www.microsoft.com/en-US/download/details.aspx?id=40784 Visual C++ Redistributable Packages for Visual Studio 2013]
* If you use v2.1alpha0 or later, you will also need:
** [https://aka.ms/vs/15/release/vc_redist.x64.exe Microsoft Visual C++ Redistributable for Visual Studio 2017]
** [https://software.intel.com/sites/default/files/managed/59/aa/ww_icl_redist_msi_2018.3.210.zip Intel C++ redistributable]

If this does not solve the problem, browse the [https://github.com/LuxCoreRender/BlendLuxCore/issues?q=is%3Aissue+label%3Ainstallation installation issues] in the bug tracker to check if your error message was already reported.
If it was not reported yet, open a new issue and copy the error message from the Blender console (on Windows, click Window -> Toggle System Console in Blender's menu. On Linux, start Blender from a terminal and try to enable the addon, then copy the error message from the terminal).

See the [[BlendLuxCore_Installation | installation page]] for information on how to install, update and remove the BlendLuxCore addon.

=== Is there something like Cycles' Layer Weight/Fresnel/Facing node in LuxCore? ===

No, in LuxCore there is no direct equivalent to this node, because it would not work with the many algorithms in LuxCore that trace rays from lights (instead of from the camera), like the bidirectional engine, light tracing mode, or the PhotonGI cache.

Of course, all materials in LuxCore are physically based and have realistic fresnel effects built-in.

You can achieve a similar effect with the dot product node, but it will work only for one viewpoint:

[[File:Layer_weight_for_one_direction.PNG | thumb | 400px | center]]

=== Can Cycles materials be used in BlendLuxCore? ===

To an extent, yes. Many common Cycles shader nodes can be used in BlendLuxCore:

* You can enable this individually for each material with the "Use Cycles Nodes" option in the material properties.
* You can also enable it for the whole scene at once with the "Use Cycles Settings" button in the render properties. This will configure all materials, lights and the world to use Cycles settings

Not all Cycles nodes and settings are supported. Here is an overview: https://github.com/LuxCoreRender/BlendLuxCore/issues/272

=== Can 2D/3D mapping be driven by textures in LuxCore? ===

In general, no, because it would lead to much worse performance on GPUs.

However, if you only need to drive the translation part of a texture mapping, since LuxCore v2.5 you can use the distort texture for this purpose:

[[File:Distort_texture.PNG | thumb | 400px | center | A checker texture (left) is distorted by a clouds texture (right). The result can be seen in the center]]

Texturing of rotation and scale is not yet possible.

=== What can be done against fireflies/hotpixels? ===

Sometimes, pixels appear that are much brighter than the surrounding pixels. Sometimes they are singular, sometimes clumped up. The underlying reason are light paths that are correct, but very hard to find with the current rendering algorithms, and thus they take much longer to render until noise-free than all other light paths in the image.

There are multiple ways to approach this problem:

* '''Try another rendering algorithm''', it might be able to find the firefly-causing light paths much easier than the one you currently use. For example, try going to the render properties, open the Light Paths panel and enable "Light Tracing", or try the [[PhotonGI | PhotonGI caustic cache]], or try using the bidirectional engine.
* You can '''clamp the brightness of all light paths''' to a maximum value, in the render properties, Light Paths panel, "Clamping" setting. BlendLuxCore can auto-detect a value for this setting that is in the right ballpark for your scene if you render once without clamping enabled, but often this value will not be the best, so you will need a bit of trial-and-error to find a good value. Note that the clamping value depends on the lighting in your scene, so there is no one universally good clamping value, and you might need to adjust it if you add a new light source to your scene that is brighter than the others. Using a clamping value that is too low will result in a low-contrast, washed-out image, while a too high value will leave fireflies unaffected.
* Try to find out which lights or materials are responsible for the fireflies. There might be small, hard-to-find light sources that are causing them. Or a specular material is reflecting such a light source. If you are willing to alter the look of the scene, you can make such a light source more visible/larger, or lower the specularity of such a material. You can also make some light sources invisble to indirect light rays, thus eliminating fireflies (light properties, "Visibility" panel). This can be a good idea for the sun, for example, if your scene contains lots of specular materials.

=== Why is my HDRI environment black and not showing up? ===
You probably have other very bright light sources in the scene, for example a sun or a sky lamp.

'''Solution:''' raise the gain value of the area or HDRI light source that is black. The gain value might need to be very high, e.g. 100000.

=== Why is my area lamp black? ===
See [[#"Why is my HDRI environment black and not showing up?"]]

=== When I change the brightness of my lamp, nothing happens ===

You are probably using an automatic tonemapper which adjusts itself to the changed brightness, making it seem like the brightness did not change.

'''Solution:''' Use a non-automatic tonemapper (camera settings -> [[ImagePipeline]]).


=== When I make one of my lights brighter, all the other lights get darker (or vice versa) ===

Similar to [[#"When I change the brightness of my lamp, nothing happens"]]. 
You are using an automatic tonemapper which tries to keep the image at the same brightness, making it seem like the brightness of the lamps changed.

'''Solution:''' Use a non-automatic tonemapper (camera settings -> [[ImagePipeline]]).


=== A material/object appears to be flickering when I move the camera and shows artifacts in final render ===

This effect is called [https://en.wikipedia.org/wiki/Z-fighting Z-fighting] and is usually caused by mesh faces being exactly on top of each other, e.g. two planes on the same world coordinates.

'''Solution:'''
* Check if there are two objects on top of each other, e.g. because you duplicated the object, cancelled the transform and forgot about it.
* Check if the mesh has duplicate faces. Enter edit mode and use the Remove Doubles button in the Tools panel, which might solve the problem in some cases.
Duplicate faces are often caused by extruding, cancelling the transform and forgetting about it.

=== There are dark triangular artifacts on my model, and I already checked for duplicate faces ===

Floating point numbers have a limited precision. When objects are very large (kilometers) or very small (micrometers), these precision issues become visible.

'''Solution:'''
* If the object has a "normal" size (something like 1 cm to 1 km), but was scaled up/down by a huge amount, try to apply the scale (Ctrl+A -> Scale). For example, this often happens with imported CAD models.
* If applying the scale did not help and your object has to be very small or large, consider to bring it into the normal scale mentioned above, and pretend that it has a larger/smaller size. For example, if you make a model of the solar system, you will just have to make the earth something like 12.742 m in diameter, and pretend that 1 m of your model is equal to 10^6 m.
* If both options above are not usable in your case, you can raise the minimum epsilon that LuxCore uses. This setting can be found in the scene properties, Units panel, after clicking "Advanced LuxCore Settings". By default, the minimum epsilon is 0.00001. Try to raise it to 0.0001 (multiply by 10) for a start and see if the artifacts disappear. Do not set this value higher than necessary, because it will cause all sorts of hard-to-track problems. Be especially careful if you are rendering a scene with volumes.

=== An object that I set to "smooth shading" looks like it is shaded flat in shadow penumbras ===

This artifact is called "terminator problem".

'''Solution:''' Unfortunately there is no real solution. You can only try to mitigate the effect by subdividing the geometry further and/or increase the size of the light source that is causing the problem.

=== How do I setup liquid in a glass container correctly? ===

This forum thread shows an example: https://forums.luxcorerender.org/viewtopic.php?f=4&t=728#p7550

=== Can I export my scene in LuxCore format to render it in LuxCore standalone? ===

Yes. In the render properties, LuxCore Tools panel, enable "FileSaver". Then render with F12.

=== How can I compile kernels from the command line? ===
Here is a way to compile kernels from the command line (out of Blender), for the latest version of pyluxcore:
<pre>
pip install pyluxcore --upgrade
python -c "import pyluxcore; pyluxcore.Init(); pyluxcore.KernelCacheFill()"
</pre>

= Getting Help =

If none of the above entries helped to solve your problem, consider asking in the [https://forums.luxcorerender.org/viewforum.php?f=4 user support forum] or [https://forums.luxcorerender.org/viewtopic.php?f=4&t=2 filing a bug report].

[[Category:BlendLuxCore]]

LuxCoreRender Release Notes v2.11

2026-04-03T11:53:15Z

CodeHD: sorting entries

= BlendLuxCore =
'''Coding/Backend'''
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* Use LuxCore internal OIDN (rather than embedding and calling an external OIDN executable)

'''Bugfix'''
* Added a workaround for a Blender bug that throws an error when Blender is closed https://projects.blender.org/blender/blender/issues/140488
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Fix rounding of convergence percentage, reaching 100% to early for complex scenes
* Fix Blender crash when clicking Copy Material

'''Features for users'''
* Update compatibility for Blender 5.0
* Fresnel texture: "custom n,k" now accepts values > 1
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space (c.f. section LuxCore)
* New shape node "MergeOnDistance" (like Blender Merge by Distance)
* Subdiv: (simple) crease management

= BlendLuxHelper =
* Adding BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel that is imported by BlendLuxCore.
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked within the scope of BlendLuxHelper)
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)

= LuxCore =

'''Coding/Backend'''
* Subdivision: multithreaded version, in order to improve speed
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Adapt CI pipelines to MacOS-15 runners (after deprecation of MacOS-13 runners on Github)
* Remove direct access to Blender internal objects. Use Blender API instead, more stable.
* Add support for Python 3.14 (and remove support for 3.9)

'''Bugfix'''
* Fix a bug leading to unstable brightness between renderings when using saved crashes (Credit to FELIX Render developers)
* Fix volume evaluation in BiDir engine https://github.com/LuxCoreRender/LuxCore/issues/647
* Fix various bugs when using orthographic camera with light tracing https://github.com/LuxCoreRender/LuxCore/issues/667
* Fix various memory-related issues (leaks, potential access violations...). Modernize memory handling (to be continued)
* Avoid crash if no OpenCL and/or Nvidia API is found
* Fix several race conditions
* Fixed an error where paused renderings can't be stopped anymore
* 3D-mapping: Fix inconsistent behavior between local and random-local mapping https://github.com/LuxCoreRender/BlendLuxCore/issues/656

'''Features for users'''
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Make `pyluxcoretools` available again (in the wheels)
* Apply the behavior of the BiDir engine w.r.t. shadow color mechanism to Path+Light tracing. Breaking change for scenes using shadow color and light tracing (not BiDir)! https://github.com/LuxCoreRender/LuxCore/issues/671
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space https://github.com/LuxCoreRender/BlendLuxCore/issues/644

= LuxCoreDeps =
* Dependencies updated to latest versions
* Better dependency pinning (for nvrtc and conan-index)
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

LuxCoreRender Release Notes v2.11

2026-04-02T11:41:38Z

CodeHD: /* BlendLuxCore */

= BlendLuxCore =

* Fresnel texture: "custom n,k" now accepts values > 1
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Added a workaround for a Blender bug that throws an error when Blender is closed https://projects.blender.org/blender/blender/issues/140488
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)
* Fix rounding of convergence percentage, reaching 100% to early for complex scenes
* Update compatibility for Blender 5.0
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space (c.f. section LuxCore(

= BlendLuxHelper =
* Adding BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel that is imported by BlendLuxCore.
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked within the scope of BlendLuxHelper)
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)

= LuxCore =
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Subdivision: multithreaded version
* Fix a bug leading to unstable brightness between renderings when using saved crashes (Credit to FELIX Render developers)
* Fix volume evaluation in BiDir engine https://github.com/LuxCoreRender/LuxCore/issues/647
* Fix various bugs when using orthographic camera with light tracing https://github.com/LuxCoreRender/LuxCore/issues/667
* Apply the behavior of the BiDir engine w.r.t. shadow color mechanism to Path+Light tracing. Breaking change for scenes using shadow color and light tracing (not BiDir)! https://github.com/LuxCoreRender/LuxCore/issues/671
* Fixed an error where paused renderings can't be stopped anymore
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space https://github.com/LuxCoreRender/BlendLuxCore/issues/644
* 3D-mapping: Fix inconsistent behavior between local and random-local mapping https://github.com/LuxCoreRender/BlendLuxCore/issues/656

= LuxCoreDeps =
* Dependencies updated to latest versions
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

LuxCoreRender Release Notes v2.11

2026-04-02T11:41:03Z

CodeHD: /* LuxCore */

= BlendLuxCore =

* Fresnel texture: "custom n,k" now accepts values > 1
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Added a workaround for a Blender bug that throws an error when Blender is closed https://projects.blender.org/blender/blender/issues/140488
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)
* Fix rounding of convergence percentage, reaching 100% to early for complex scenes
* Update compatibility for Blender 5.0
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space

= BlendLuxHelper =
* Adding BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel that is imported by BlendLuxCore.
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked within the scope of BlendLuxHelper)
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)

= LuxCore =
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Subdivision: multithreaded version
* Fix a bug leading to unstable brightness between renderings when using saved crashes (Credit to FELIX Render developers)
* Fix volume evaluation in BiDir engine https://github.com/LuxCoreRender/LuxCore/issues/647
* Fix various bugs when using orthographic camera with light tracing https://github.com/LuxCoreRender/LuxCore/issues/667
* Apply the behavior of the BiDir engine w.r.t. shadow color mechanism to Path+Light tracing. Breaking change for scenes using shadow color and light tracing (not BiDir)! https://github.com/LuxCoreRender/LuxCore/issues/671
* Fixed an error where paused renderings can't be stopped anymore
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space https://github.com/LuxCoreRender/BlendLuxCore/issues/644
* 3D-mapping: Fix inconsistent behavior between local and random-local mapping https://github.com/LuxCoreRender/BlendLuxCore/issues/656

= LuxCoreDeps =
* Dependencies updated to latest versions
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

LuxCoreRender Release Notes v2.11

2026-04-02T11:34:31Z

CodeHD: /* BlendLuxCore */

= BlendLuxCore =

* Fresnel texture: "custom n,k" now accepts values > 1
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Added a workaround for a Blender bug that throws an error when Blender is closed https://projects.blender.org/blender/blender/issues/140488
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)
* Fix rounding of convergence percentage, reaching 100% to early for complex scenes
* Update compatibility for Blender 5.0
* 2D-mapping: Add an option to allow rotation around the center of UV-coordinate space

= BlendLuxHelper =
* Adding BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel that is imported by BlendLuxCore.
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked within the scope of BlendLuxHelper)
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)

= LuxCore =
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Subdivision: multithreaded version
* Fix a bug leading to unstable brightness between renderings when using saved crashes (Credit to FELIX Render developers)
* Fix volume evaluation in BiDir engine https://github.com/LuxCoreRender/LuxCore/issues/647
* Fix various bugs when using orthographic camera with light tracing https://github.com/LuxCoreRender/LuxCore/issues/667
* Apply the behavior of the BiDir engine w.r.t. shadow color mechanism to Path+Light tracing. Breaking change for scenes using shadow color and light tracing (not BiDir)!

= LuxCoreDeps =
* Dependencies updated to latest versions
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

LuxCoreRender Release Notes v2.11

2026-04-02T11:30:03Z

CodeHD: Split BlendLuxHelper into its own category

= BlendLuxCore =

* Fresnel texture: "custom n,k" now accepts values > 1

* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Added a workaround for a Blender bug that throws an error when Blender is closed
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)

= BlendLuxHelper =
* Adding BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel that is imported by BlendLuxCore.
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked within the scope of BlendLuxHelper)
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)

= LuxCore =
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Subdivision: multithreaded version
* Fix a bug leading to unstable brightness between renderings when using saved crashes (Credit to FELIX Render developers)
* Fix volume evaluation in BiDir engine https://github.com/LuxCoreRender/LuxCore/issues/647
* Fix various bugs when using orthographic camera with light tracing https://github.com/LuxCoreRender/LuxCore/issues/667
* Apply the behavior of the BiDir engine w.r.t. shadow color mechanism to Path+Light tracing. Breaking change for scenes using shadow color and light tracing (not BiDir)!

= LuxCoreDeps =
* Dependencies updated to latest versions
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

LuxCoreRender Release Notes v2.10

2025-10-23T20:30:56Z

CodeHD: /* BlendLuxCore */

__TOC__

=Bugfix release v2.10.2=

===LuxCore===

===BlendLuxCore===
* Fix an issue with the blendev utility script and the .gitignore file
* Remove some filtering of Intel devices left from times when iGPU devices were not powerful enough
* Remove deprecated bgl imports, to establish preliminary compatibility with Blender 5.0.0-beta
* Change the calculation of percentage completion when using noise threshold to avoid the display being stuck at 100% before the rendering is actually finished

=Bugfix release v2.10.1=

===LuxCore===
* Fixed a bug in luxcoreui (crash when loading a new .cfg file)
* Pin nvrtc dependency of pyluxcore to a specific version

===BlendLuxCore===
* Added a workaround for a Blender bug that throws an error when Blender is closed: [https://projects.blender.org/blender/blender/issues/140488 Blender Issue Tracker]
* Added a linux development shell script (optional utility for developers, [https://wiki.luxcorerender.org/Developing_and_debugging_BlendLuxCore#Utility_shell_script_for_launching_Blender see here])
* Viewport: Limit values in extremely overexposed areas, previously causing these areas to appear black

=LuxCore=

===New Features===

* New, multiplatform dependency manager: LuxCoreDeps. The new dep manager is based on Conan, an open source software which gives access to a database of thousands of build recipes, maintained up-to-date both by a company (JFrog) and a dynamic community. The deps are now built from sources, for a better control of build settings, binary compatibility etc.

* Dependencies updated to latest versions

* Buildability restored for all previous platforms: Linux, Windows, MacOS Intel

* Buildability added MacOS ARM platform.

* LuxCoreRender delivered in the form of Python wheels, published on PyPi.

* Automation (check, build, publish...) rewritten in Github Actions

===Fixed Bugs===

* LuxCore is now buildable again, on all previous platforms (Linux, Windows, MacOS Intel) + one (MacOS ARM).
* Crash fixed on tile path

===Known Problems===

= BlendLuxCore =

===New Features===
* Compatibility for Blender 4.2 and 4.3
* Partial compatibility for Blender 4.4 (not a release goal)
* Moved from Blenders addon system to the new extension system
* BlendLuxCore no longer bundles LuxCore binaries, platform specific binaries now distributed via PyPi
* Changed build pipeline from Azure to GitHub CI/CD
* Add square-root option to math node (alias to power 0.5)
* Add a setting to suppress LuxCore console log output
* Glass material now accepts IOR < 1
* Materials can now be individually excluded from material override
* BlendLuxCore specific menus are marked with an icon

===Fixed Bugs===
* Motion blur support for instances
* Improve custom normals export time by utilizing mesh.loops.foreach_get()
* LOL: Changed data access to adapt to new webhosting requirements

===Known Problems===
* Crashes are observed on macOS with Blender 4.2 and Blender 4.3. Related to window resizing and render completion. Unknown if Blender specific or also happening in standalone.
* Motion blur does not seem to work on "deeper iterations", e.g. copying an instanced object

LuxCoreRender Release Notes v2.10

2025-10-23T19:53:42Z

CodeHD: /* BlendLuxCore */

__TOC__

=Bugfix release v2.10.2=

===LuxCore===

===BlendLuxCore===
* fix an issue with the blendev utility script and the .gitignore file
* Remove some filtering of Intel devices left from times when iGPU devices were not powerful enough
* Remove deprecated bgl imports, to establish preliminary compatibility with Blender 5.0.0-beta
* Change the calculation of percentage completion when using noise threshold to avoid the display being stuck at 100% before the rendering is actually finished

=Bugfix release v2.10.1=

===LuxCore===
* Fixed a bug in luxcoreui (crash when loading a new .cfg file)
* Pin nvrtc dependency of pyluxcore to a specific version

===BlendLuxCore===
* Added a workaround for a Blender bug that throws an error when Blender is closed: [https://projects.blender.org/blender/blender/issues/140488 Blender Issue Tracker]
* Added a linux development shell script (optional utility for developers, [https://wiki.luxcorerender.org/Developing_and_debugging_BlendLuxCore#Utility_shell_script_for_launching_Blender see here])
* Viewport: Limit values in extremely overexposed areas, previously causing these areas to appear black

=LuxCore=

===New Features===

* New, multiplatform dependency manager: LuxCoreDeps. The new dep manager is based on Conan, an open source software which gives access to a database of thousands of build recipes, maintained up-to-date both by a company (JFrog) and a dynamic community. The deps are now built from sources, for a better control of build settings, binary compatibility etc.

* Dependencies updated to latest versions

* Buildability restored for all previous platforms: Linux, Windows, MacOS Intel

* Buildability added MacOS ARM platform.

* LuxCoreRender delivered in the form of Python wheels, published on PyPi.

* Automation (check, build, publish...) rewritten in Github Actions

===Fixed Bugs===

* LuxCore is now buildable again, on all previous platforms (Linux, Windows, MacOS Intel) + one (MacOS ARM).
* Crash fixed on tile path

===Known Problems===

= BlendLuxCore =

===New Features===
* Compatibility for Blender 4.2 and 4.3
* Partial compatibility for Blender 4.4 (not a release goal)
* Moved from Blenders addon system to the new extension system
* BlendLuxCore no longer bundles LuxCore binaries, platform specific binaries now distributed via PyPi
* Changed build pipeline from Azure to GitHub CI/CD
* Add square-root option to math node (alias to power 0.5)
* Add a setting to suppress LuxCore console log output
* Glass material now accepts IOR < 1
* Materials can now be individually excluded from material override
* BlendLuxCore specific menus are marked with an icon

===Fixed Bugs===
* Motion blur support for instances
* Improve custom normals export time by utilizing mesh.loops.foreach_get()
* LOL: Changed data access to adapt to new webhosting requirements

===Known Problems===
* Crashes are observed on macOS with Blender 4.2 and Blender 4.3. Related to window resizing and render completion. Unknown if Blender specific or also happening in standalone.
* Motion blur does not seem to work on "deeper iterations", e.g. copying an instanced object

LuxCoreRender Release Notes v2.10

2025-10-23T19:50:52Z

CodeHD: Add section for v2.10.2

__TOC__

=Bugfix release v2.10.2=

===LuxCore===

===BlendLuxCore===

=Bugfix release v2.10.1=

===LuxCore===
* Fixed a bug in luxcoreui (crash when loading a new .cfg file)
* Pin nvrtc dependency of pyluxcore to a specific version

===BlendLuxCore===
* Added a workaround for a Blender bug that throws an error when Blender is closed: [https://projects.blender.org/blender/blender/issues/140488 Blender Issue Tracker]
* Added a linux development shell script (optional utility for developers, [https://wiki.luxcorerender.org/Developing_and_debugging_BlendLuxCore#Utility_shell_script_for_launching_Blender see here])
* Viewport: Limit values in extremely overexposed areas, previously causing these areas to appear black

=LuxCore=

===New Features===

* New, multiplatform dependency manager: LuxCoreDeps. The new dep manager is based on Conan, an open source software which gives access to a database of thousands of build recipes, maintained up-to-date both by a company (JFrog) and a dynamic community. The deps are now built from sources, for a better control of build settings, binary compatibility etc.

* Dependencies updated to latest versions

* Buildability restored for all previous platforms: Linux, Windows, MacOS Intel

* Buildability added MacOS ARM platform.

* LuxCoreRender delivered in the form of Python wheels, published on PyPi.

* Automation (check, build, publish...) rewritten in Github Actions

===Fixed Bugs===

* LuxCore is now buildable again, on all previous platforms (Linux, Windows, MacOS Intel) + one (MacOS ARM).
* Crash fixed on tile path

===Known Problems===

= BlendLuxCore =

===New Features===
* Compatibility for Blender 4.2 and 4.3
* Partial compatibility for Blender 4.4 (not a release goal)
* Moved from Blenders addon system to the new extension system
* BlendLuxCore no longer bundles LuxCore binaries, platform specific binaries now distributed via PyPi
* Changed build pipeline from Azure to GitHub CI/CD
* Add square-root option to math node (alias to power 0.5)
* Add a setting to suppress LuxCore console log output
* Glass material now accepts IOR < 1
* Materials can now be individually excluded from material override
* BlendLuxCore specific menus are marked with an icon

===Fixed Bugs===
* Motion blur support for instances
* Improve custom normals export time by utilizing mesh.loops.foreach_get()
* LOL: Changed data access to adapt to new webhosting requirements

===Known Problems===
* Crashes are observed on macOS with Blender 4.2 and Blender 4.3. Related to window resizing and render completion. Unknown if Blender specific or also happening in standalone.
* Motion blur does not seem to work on "deeper iterations", e.g. copying an instanced object

LuxCoreRender Release Notes v2.11

2025-10-11T19:20:17Z

CodeHD: /* LuxCore */

= BlendLuxCore =

* Fresnel texture: "custom n,k" now accepts values > 1
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked again within the scope of BlendLuxHelper)
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Added a workaround for a Blender bug that throws an error when Blender is closed
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel which is imported by BlendLuxCore.
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)

= LuxCore =
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Subdivision: multithreaded version
* Fix a bug leading to unstable brightness between renderings when using saved crashes (Credit to FELIX Render developers)
* Fix volume evaluation in BiDir engine https://github.com/LuxCoreRender/LuxCore/issues/647
* Fix various bugs when using orthographic camera with light tracing https://github.com/LuxCoreRender/LuxCore/issues/667
* Apply the behavior of the BiDir engine w.r.t. shadow color mechanism to Path+Light tracing. Breaking change for scenes using shadow color and light tracing (not BiDir)!

= LuxCoreDeps =
* Dependencies updated to latest versions
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

LuxCoreRender Release Notes v2.11

2025-10-11T19:10:31Z

CodeHD: /* BlendLuxCore */

= BlendLuxCore =

* Fresnel texture: "custom n,k" now accepts values > 1
* <del>Change installation mechanism to use bpy.utils.extension_path_user()</del> (Reworked again within the scope of BlendLuxHelper)
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Added a workaround for a Blender bug that throws an error when Blender is closed
* <del>Added a Linux development shell script (optional utility for developers)</del> (replaced by BlendLuxHelper)
* Remove leftover code from the Addons system that is no longer used with the Extensions system.
* BlendLuxHelper: A new helper, in the form of a Blender extension, which allows to configure the wheel which is imported by BlendLuxCore.
* Limit float values in viewport render to 16-bit in order to avoid overexposed areas being displayed as black.
* Remove default filtering of Intel GPU devices
* Add a checkbox to the material output node for enabling an override: When using shadow color, this allows light rays in addition to the shadow rays. (default off == no light rays, only shadow rays)

= LuxCore =
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement
* Subdivision: multithreaded version

= LuxCoreDeps =
* Dependencies updated to latest versions
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.
* Embree: Upgraded to version 4.
* libjpeg: Replaced with libjpeg-turbo

Developing and debugging BlendLuxCore

2025-10-07T19:51:03Z

CodeHD: /* Installation of BlendLuxHelper and Setup of BlendLuxCore */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper (BLH).

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment. 
Suggested name: <code>blc_dbg</code>

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender through the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

To use a custom wheel of pyluxcore, open the addon preferences of BLH.
Set the option <code>Wheel Source</code> to <code>Local Wheel</code>. You can then enter a <code>Path to Wheel file</code>, which must point to the wheel itself, not the folder where it is located!

At each startup (or reload), BLC computes a hash of the linked wheel. This hash is compared against information stored in a local file, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel, and update accordingly if you change the selection of <code>Wheel Source</code>.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore [...]</code> --> A local version will be used. 
<code>[BLC] installing pyluxcore version: [...]</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. [...]</code> --> BLC detected that the installed wheel matches the designated wheel, and installation is skipped. 

(Note: Further error messages exist but they are out of the scope of this article.)

= Scenario #3: Offline installation =

When you need to perform an offline installation, you first need to download the dependencies of pyluxcore as wheel-files. 
If you are unsure about the correct modules and versions, or where to get them, please ask on the support channels (Forum, Discord, ...).

In the BLH addon preferences, first configure to use a Local Wheel as described in the previous section.

Then, use the additional option <code>Path to additional dependency folder (optional)</code> to specify the path where the dependencies are located. 
In this field enter a folder path that contains all the dependency wheels that you previously downloaded. (Not a wheel directly, as required in the previous section.)

At the next startup, Blender will install the local wheel including the local dependencies.

= Tips & Tricks =

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file:

<code>$HOME/.config/blender/<blender-version>/extensions/.user/<repository>/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T19:50:50Z

CodeHD: /* Installation of BlendLuxHelper and Setup of BlendLuxCore */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper (BLH).

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.
Suggested name: <code>blc_dbg</code>

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender through the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

To use a custom wheel of pyluxcore, open the addon preferences of BLH.
Set the option <code>Wheel Source</code> to <code>Local Wheel</code>. You can then enter a <code>Path to Wheel file</code>, which must point to the wheel itself, not the folder where it is located!

At each startup (or reload), BLC computes a hash of the linked wheel. This hash is compared against information stored in a local file, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel, and update accordingly if you change the selection of <code>Wheel Source</code>.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore [...]</code> --> A local version will be used. 
<code>[BLC] installing pyluxcore version: [...]</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. [...]</code> --> BLC detected that the installed wheel matches the designated wheel, and installation is skipped. 

(Note: Further error messages exist but they are out of the scope of this article.)

= Scenario #3: Offline installation =

When you need to perform an offline installation, you first need to download the dependencies of pyluxcore as wheel-files. 
If you are unsure about the correct modules and versions, or where to get them, please ask on the support channels (Forum, Discord, ...).

In the BLH addon preferences, first configure to use a Local Wheel as described in the previous section.

Then, use the additional option <code>Path to additional dependency folder (optional)</code> to specify the path where the dependencies are located. 
In this field enter a folder path that contains all the dependency wheels that you previously downloaded. (Not a wheel directly, as required in the previous section.)

At the next startup, Blender will install the local wheel including the local dependencies.

= Tips & Tricks =

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file:

<code>$HOME/.config/blender/<blender-version>/extensions/.user/<repository>/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T19:50:09Z

CodeHD: /* Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper (BLH).

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender through the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

To use a custom wheel of pyluxcore, open the addon preferences of BLH.
Set the option <code>Wheel Source</code> to <code>Local Wheel</code>. You can then enter a <code>Path to Wheel file</code>, which must point to the wheel itself, not the folder where it is located!

At each startup (or reload), BLC computes a hash of the linked wheel. This hash is compared against information stored in a local file, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel, and update accordingly if you change the selection of <code>Wheel Source</code>.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore [...]</code> --> A local version will be used. 
<code>[BLC] installing pyluxcore version: [...]</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. [...]</code> --> BLC detected that the installed wheel matches the designated wheel, and installation is skipped. 

(Note: Further error messages exist but they are out of the scope of this article.)

= Scenario #3: Offline installation =

When you need to perform an offline installation, you first need to download the dependencies of pyluxcore as wheel-files. 
If you are unsure about the correct modules and versions, or where to get them, please ask on the support channels (Forum, Discord, ...).

In the BLH addon preferences, first configure to use a Local Wheel as described in the previous section.

Then, use the additional option <code>Path to additional dependency folder (optional)</code> to specify the path where the dependencies are located. 
In this field enter a folder path that contains all the dependency wheels that you previously downloaded. (Not a wheel directly, as required in the previous section.)

At the next startup, Blender will install the local wheel including the local dependencies.

= Tips & Tricks =

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file:

<code>$HOME/.config/blender/<blender-version>/extensions/.user/<repository>/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T19:49:32Z

CodeHD: /* Statement of problem */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper (BLH).

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender through the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

To use a custom wheel of pyluxcore, open the addon preferences of BLH.
Set the option <code>Wheel Source</code> to <code>Local Wheel</code>. You can then enter a <code>Path to Wheel file</code>, which must point to the wheel itself, not the folder where it is located!

At each startup (or reload), BLC computes a hash of the linked wheel. This hash is compared against information stored in a local file, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel, and update accordingly if you change the selection of <code>Wheel Source</code>.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore [...]</code> --> A local version will be used. 
<code>[BLC] installing pyluxcore version: [...]</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. [...]</code> --> BLC detected that the installed wheel matches the designated wheel, and installation is skipped. 

(Note: Further error messages exist but they are out of the scope of this article.)

= Scenario #3: Offline installation =

When you need to perform an offline installation, you first need to download the dependencies of pyluxcore as wheel-files. 
If you are unsure about the correct modules and versions, or where to get them, please ask on the support channels (Forum, Discord, ...).

In the BLH addon preferences, first configure to use a Local Wheel as described in the previous section.

Then, use the additional option <code>Path to additional dependency folder (optional)</code> to specify the path where the dependencies are located. 
In this field enter a folder path that contains all the dependency wheels that you previously downloaded. (Not a wheel directly, as required in the previous section.)

At the next startup, Blender will install the local wheel including the local dependencies.

= Tips & Tricks =

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file:

<code>$HOME/.config/blender/<blender-version>/extensions/.user/blc_dbg/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T19:01:06Z

CodeHD: /* Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender thorugh the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

To use a custom wheel of pyluxcore, open the addon preferences of BLH.
Set the option <code>Wheel Source</code> to <code>Local Wheel</code>. You can then enter a <code>Path to Wheel file</code>, which must point to the wheel itself, not the folder where it is located!

At each startup (or reload), BLC computes a hash of the linked wheel. This hash is compared against information stored in a local file, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel, and update accordingly if you change the selection of <code>Wheel Source</code>.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore [...]</code> --> A local version will be used. 
<code>[BLC] installing pyluxcore version: [...]</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. [...]</code> --> BLC detected that the installed wheel matches the designated wheel, and installation is skipped. 

(Note: Further error messages exist but they are out of the scope of this article.)

= Scenario #3: Offline installation =

When you need to perform an offline installation, you first need to download the dependencies of pyluxcore as wheel-files. 
If you are unsure about the correct modules and versions, or where to get them, please ask on the support channels (Forum, Discord, ...).

In the BLH addon preferences, first configure to use a Local Wheel as described in the previous section.

Then, use the additional option <code>Path to additional dependency folder (optional)</code> to specify the path where the dependencies are located. 
In this field enter a folder path that contains all the dependency wheels that you previously downloaded. (Not a wheel directly, as required in the previous section.)

At the next startup, Blender will install the local wheel including the local dependencies.

= Tips & Tricks =

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

THIS SECTION NEEDS AN UPDATE

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T19:00:17Z

CodeHD: Add offline installation option

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender thorugh the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

To use a custom wheel of pyluxcore, open the addon preferences of BLH.
Set the option <code>Wheel Source</code> to <code>Local Wheel</code>. You can then enter a <code>Path to Wheel file</code>, which must point to the wheel itself, not the folder where it is located!

At each startup (or reload), BLC computes a hash of the linked wheel. This hash is compared against information stored in a local file, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel, and update accordingly if you change the selection of <code>Wheel Source</code>.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore [...]</code> --> A local version will be used. 
<code>[BLC] installing pyluxcore version: [...]</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. [...]</code> --> BLC detected that the installed wheel matches the designated wheel, and installation is skipped. 

(Note: Further error messages exist but they are out of the scope of this article.)

= Scenario #3: Offline installation =

When you need to perform an offline installation, you first need to download the dependencies of pyluxcore as wheel-files. 
If you are unsure about the correct modules and versions, or where to get them, please ask on the support channels (Forum, Discord, ...).

In the BLH addon preferences, first configure to use a Local Wheel as described in the previous section.

Then, use the additional option <code>Path to additional dependency folder (optional)</code> to specify the path where the dependencies are located. 
In this field enter a folder path that contains all the dependency wheels that you previously downloaded. (Not a wheel directly, as required in the previous section.)

At the next startup, Blender will install the local wheel including the local dependencies.

= Tips & Tricks =

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T18:47:39Z

CodeHD: /* Tips & Tricks */ Remove obsolete sections

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender thorugh the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

To use a custom wheel of pyluxcore, open the addon preferences of BLH.
Set the option <code>Wheel Source</code> to <code>Local Wheel</code>. You can then enter a <code>Path to Wheel file</code>, which must point to the wheel itself, not the folder where it is located!

At each startup (or reload), BLC computes a hash of the linked wheel. This hash is compared against information stored in a local file, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel, and update accordingly if you change the selection of <code>Wheel Source</code>.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore [...]</code> --> A local version will be used. 
<code>[BLC] installing pyluxcore version: [...]</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. [...]</code> --> BLC detected that the installed wheel matches the designated wheel, and installation is skipped. 

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T18:47:05Z

CodeHD: /* Scenario #2: Working on pyluxcore */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender thorugh the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

To use a custom wheel of pyluxcore, open the addon preferences of BLH.
Set the option <code>Wheel Source</code> to <code>Local Wheel</code>. You can then enter a <code>Path to Wheel file</code>, which must point to the wheel itself, not the folder where it is located!

At each startup (or reload), BLC computes a hash of the linked wheel. This hash is compared against information stored in a local file, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel, and update accordingly if you change the selection of <code>Wheel Source</code>.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore [...]</code> --> A local version will be used. 
<code>[BLC] installing pyluxcore version: [...]</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. [...]</code> --> BLC detected that the installed wheel matches the designated wheel, and installation is skipped. 

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T18:39:44Z

CodeHD: /* Scenario #1: Working on BLC, using standard pyluxcore */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender thorugh the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

If you followed the previous instructions and installed BLC via a symbolic link, BLC will always be loaded from your local git repository source at Blender startup.

if you make changes to BLC and want to reload the addon, you can use Blenders internal function "Reload Scripts". 
Nota: This feature is WIP for BLC and may not yet be functional for all of its submodules.

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T18:36:05Z

CodeHD: /* Installation of BlendLuxHelper and Setup of BlendLuxCore */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender thorugh the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

Step 5: 
Close and reopen Blender. Go to the addon-preferences menu and enable the BLC addon.
The addon should now be installed, including the installation of pyluxcore and its dependencies.

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path folder containing the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set <code>BLC_DEV_PATH</code> to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that Python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all Python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T18:33:57Z

CodeHD: Add section about BLH installation

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Installation of BlendLuxHelper and Setup of BlendLuxCore =

Step 1: 
Uninstall any previously installed version of BLC.

Step 2 (optional): 
Add a new local extension repository for installation of the BLC/BLH development environment.

Step 3: 
Download the latest release of [https://github.com/LuxCoreRender/BlendLuxHelper BLH on GitHub], or - if necessary - build the extension from source.

Install BLH in Blender thorugh the extensions menu using the [https://docs.blender.org/manual/en/latest/editors/preferences/extensions.html#bpy-ops-extensions-package-install-files Install from Disk] option.

Step 4: 
Create a symbolic link to the local BLC git-repository, as outlined in Blenders Add-on Development Setup guide.
In the Addon preferences menu of BLH, at the bottom, you can find a function to perform this step with a graphical interface.

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path folder containing the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set <code>BLC_DEV_PATH</code> to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that Python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all Python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T18:21:07Z

CodeHD: /* Prerequisites */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

You made yourself familiar with Blenders official [https://developer.blender.org/docs/handbook/extensions/addon_dev_setup/ Add-on Development Setup] guide.

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path folder containing the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set <code>BLC_DEV_PATH</code> to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that Python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all Python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T18:07:30Z

CodeHD: /* Statement of problem */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

In addition, there may be the need to handle some unusual cases, for example performing an offline-installation in restrictive company networks where dependencies cannot be downloaded via pip.

To facilitate the configuration of these scenarios, we provide a separate extension, BlendLuxHelper.

The setup and usage of BlendLuxCore together with BlendLuxHelper will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path folder containing the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set <code>BLC_DEV_PATH</code> to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that Python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all Python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T17:56:07Z

CodeHD: /* Goal and audience */

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.
* Use cases with non-standard requirements, e.g. the need to perform an offline installation.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path _folder containing_ the development repo of BlendLuxCore

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed python module. A development version of the wheel can be copied into this folder.

These methods will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path folder containing the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set <code>BLC_DEV_PATH</code> to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that Python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all Python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore

2025-10-07T17:54:55Z

CodeHD: Add note about v2.11 WIP content

= Introduction =

Note: This article is work in progress for the development of BlendLuxCore v2.11. Instructions for v2.10 can be found in the article [[Developing and debugging BlendLuxCore v2.10]] 

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path _folder containing_ the development repo of BlendLuxCore

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed python module. A development version of the wheel can be copied into this folder.

These methods will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path folder containing the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set <code>BLC_DEV_PATH</code> to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that Python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all Python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore v2.10

2025-10-07T17:53:05Z

CodeHD: Add note about deprecation

Note: This page is documenting the development process used in v2.10.x of BlendLuxCore. The content is no longer under active development. See the main article [[Developing and debugging BlendLuxCore]] for the latest instructions.

= Introduction =

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path _folder containing_ the development repo of BlendLuxCore

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed python module. A development version of the wheel can be copied into this folder.

These methods will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path folder containing the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set <code>BLC_DEV_PATH</code> to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that Python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all Python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

Developing and debugging BlendLuxCore v2.10

2025-10-07T17:45:53Z

CodeHD: Created page with "= Introduction = == Goal and audience == This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. The targeted audience encompasses: * BlendLuxCore development contributors * BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature. * LuxCore developers who want to use Blender as a tool to test changes to the core eng..."

= Introduction =

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path _folder containing_ the development repo of BlendLuxCore

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed python module. A development version of the wheel can be copied into this folder.

These methods will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path folder containing the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set <code>BLC_DEV_PATH</code> to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that Python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all Python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed Python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precedence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed Python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

LuxCoreRender Release Notes v2.10

2025-07-25T08:36:55Z

CodeHD: /* Bugfix release v2.10.1 */

__TOC__

=Bugfix release v2.10.1=

===LuxCore===
* Fixed a bug in luxcoreui (crash when loading a new .cfg file)
* Pin nvrtc dependency of pyluxcore to a specific version

===BlendLuxCore===
* Added a workaround for a Blender bug that throws an error when Blender is closed: [https://projects.blender.org/blender/blender/issues/140488 Blender Issue Tracker]
* Added a linux development shell script (optional utility for developers, [https://wiki.luxcorerender.org/Developing_and_debugging_BlendLuxCore#Utility_shell_script_for_launching_Blender see here])
* Viewport: Limit values in extremely overexposed areas, previously causing these areas to appear black

=LuxCore=

===New Features===

* New, multiplatform dependency manager: LuxCoreDeps. The new dep manager is based on Conan, an open source software which gives access to a database of thousands of build recipes, maintained up-to-date both by a company (JFrog) and a dynamic community. The deps are now built from sources, for a better control of build settings, binary compatibility etc.

* Dependencies updated to latest versions

* Buildability restored for all previous platforms: Linux, Windows, MacOS Intel

* Buildability added MacOS ARM platform.

* LuxCoreRender delivered in the form of Python wheels, published on PyPi.

* Automation (check, build, publish...) rewritten in Github Actions

===Fixed Bugs===

* LuxCore is now buildable again, on all previous platforms (Linux, Windows, MacOS Intel) + one (MacOS ARM).
* Crash fixed on tile path

===Known Problems===

= BlendLuxCore =

===New Features===
* Compatibility for Blender 4.2 and 4.3
* Partial compatibility for Blender 4.4 (not a release goal)
* Moved from Blenders addon system to the new extension system
* BlendLuxCore no longer bundles LuxCore binaries, platform specific binaries now distributed via PyPi
* Changed build pipeline from Azure to GitHub CI/CD
* Add square-root option to math node (alias to power 0.5)
* Add a setting to suppress LuxCore console log output
* Glass material now accepts IOR < 1
* Materials can now be individually excluded from material override
* BlendLuxCore specific menus are marked with an icon

===Fixed Bugs===
* Motion blur support for instances
* Improve custom normals export time by utilizing mesh.loops.foreach_get()
* LOL: Changed data access to adapt to new webhosting requirements

===Known Problems===
* Crashes are observed on macOS with Blender 4.2 and Blender 4.3. Related to window resizing and render completion. Unknown if Blender specific or also happening in standalone.
* Motion blur does not seem to work on "deeper iterations", e.g. copying an instanced object

LuxCoreRender Release Notes v2.10

2025-07-23T15:21:37Z

CodeHD: /* Bugfix release v2.10.1 */

__TOC__

=Bugfix release v2.10.1=

===LuxCore===
* Fixed a bug in luxcoreui (crash when loading a new .cfg file)
* Pin nvrtc dependency of pyluxcore to a specific version

===BlendLuxCore===
* Added a workaround for a Blender bug that throws an error when Blender is closed: [https://projects.blender.org/blender/blender/issues/140488 Blender Issue Tracker]
* Added a linux development shell script (optional utility for developers)
* Viewport: Limit values in extremely overexposed areas, previously causing these areas to appear black

=LuxCore=

===New Features===

* New, multiplatform dependency manager: LuxCoreDeps. The new dep manager is based on Conan, an open source software which gives access to a database of thousands of build recipes, maintained up-to-date both by a company (JFrog) and a dynamic community. The deps are now built from sources, for a better control of build settings, binary compatibility etc.

* Dependencies updated to latest versions

* Buildability restored for all previous platforms: Linux, Windows, MacOS Intel

* Buildability added MacOS ARM platform.

* LuxCoreRender delivered in the form of Python wheels, published on PyPi.

* Automation (check, build, publish...) rewritten in Github Actions

===Fixed Bugs===

* LuxCore is now buildable again, on all previous platforms (Linux, Windows, MacOS Intel) + one (MacOS ARM).
* Crash fixed on tile path

===Known Problems===

= BlendLuxCore =

===New Features===
* Compatibility for Blender 4.2 and 4.3
* Partial compatibility for Blender 4.4 (not a release goal)
* Moved from Blenders addon system to the new extension system
* BlendLuxCore no longer bundles LuxCore binaries, platform specific binaries now distributed via PyPi
* Changed build pipeline from Azure to GitHub CI/CD
* Add square-root option to math node (alias to power 0.5)
* Add a setting to suppress LuxCore console log output
* Glass material now accepts IOR < 1
* Materials can now be individually excluded from material override
* BlendLuxCore specific menus are marked with an icon

===Fixed Bugs===
* Motion blur support for instances
* Improve custom normals export time by utilizing mesh.loops.foreach_get()
* LOL: Changed data access to adapt to new webhosting requirements

===Known Problems===
* Crashes are observed on macOS with Blender 4.2 and Blender 4.3. Related to window resizing and render completion. Unknown if Blender specific or also happening in standalone.
* Motion blur does not seem to work on "deeper iterations", e.g. copying an instanced object

LuxCoreRender Release Notes v2.10

2025-07-23T15:04:01Z

CodeHD: /* Bugfix release v2.10.1 */

__TOC__

=Bugfix release v2.10.1=

===LuxCore===
* Fixed a bug in luxcoreui (crash when loading a new .cfg file)
* Pin nvrtc dependency of pyluxcore to a specific version

===BlendLuxCore===
* Added a workaround for a Blender bug that throws an error when Blender is closed
* Added a linux development shell script (optional utility for developers)
* Viewport: Limit values in extremely overexposed areas, previously causing these areas to appear black

=LuxCore=

===New Features===

* New, multiplatform dependency manager: LuxCoreDeps. The new dep manager is based on Conan, an open source software which gives access to a database of thousands of build recipes, maintained up-to-date both by a company (JFrog) and a dynamic community. The deps are now built from sources, for a better control of build settings, binary compatibility etc.

* Dependencies updated to latest versions

* Buildability restored for all previous platforms: Linux, Windows, MacOS Intel

* Buildability added MacOS ARM platform.

* LuxCoreRender delivered in the form of Python wheels, published on PyPi.

* Automation (check, build, publish...) rewritten in Github Actions

===Fixed Bugs===

* LuxCore is now buildable again, on all previous platforms (Linux, Windows, MacOS Intel) + one (MacOS ARM).
* Crash fixed on tile path

===Known Problems===

= BlendLuxCore =

===New Features===
* Compatibility for Blender 4.2 and 4.3
* Partial compatibility for Blender 4.4 (not a release goal)
* Moved from Blenders addon system to the new extension system
* BlendLuxCore no longer bundles LuxCore binaries, platform specific binaries now distributed via PyPi
* Changed build pipeline from Azure to GitHub CI/CD
* Add square-root option to math node (alias to power 0.5)
* Add a setting to suppress LuxCore console log output
* Glass material now accepts IOR < 1
* Materials can now be individually excluded from material override
* BlendLuxCore specific menus are marked with an icon

===Fixed Bugs===
* Motion blur support for instances
* Improve custom normals export time by utilizing mesh.loops.foreach_get()
* LOL: Changed data access to adapt to new webhosting requirements

===Known Problems===
* Crashes are observed on macOS with Blender 4.2 and Blender 4.3. Related to window resizing and render completion. Unknown if Blender specific or also happening in standalone.
* Motion blur does not seem to work on "deeper iterations", e.g. copying an instanced object

BlendLuxCore FAQ

2025-07-21T08:33:11Z

CodeHD: Add "could not import pyluxcore" section

= Frequently Asked Questions =

=== When trying to use CUDA/OptiX, I get the error message: <code>RUNTIME ERROR: CUDA driver API error CUDA_ERROR_UNSUPPORTED_PTX_VERSION (code: 222, file:.../cuda.cpp, line: xxx): the provided PTX was compiled with an unsupported toolchain.</code> ===

Your nvidia driver is too old compared to nvidia runtime compiler used by LuxCore, so the code compiled by LuxCore runtime compiler cannot be run by your driver.

Please upgrade your nvidia driver to latest version, or at least to a suitable version with regard to runtime compiler: https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html#id7

=== After installation, I get the error message "could not import pyluxcore" ===

"pyluxcore" is the binary core library. BlendLuxCore downloads and installs the correct version for your system during installation. This error indicates something went wrong with this installation. Possible solutions are:
* Check that online access is allowed in the Blender preferences.
* Download may be restricted in company networks. You can try an [https://wiki.luxcorerender.org/BlendLuxCore_Installation#Offline_Installation offline-installation].

=== I can not enable the BlendLuxCore addon, it shows errors ===

Most problems in this area stem from broken graphics driver installations. Try to re-install or update your graphics driver.

'''For Windows users:'''
* Make sure that you have installed the [https://www.microsoft.com/en-US/download/details.aspx?id=40784 Visual C++ Redistributable Packages for Visual Studio 2013]
* If you use v2.1alpha0 or later, you will also need:
** [https://aka.ms/vs/15/release/vc_redist.x64.exe Microsoft Visual C++ Redistributable for Visual Studio 2017]
** [https://software.intel.com/sites/default/files/managed/59/aa/ww_icl_redist_msi_2018.3.210.zip Intel C++ redistributable]

If this does not solve the problem, browse the [https://github.com/LuxCoreRender/BlendLuxCore/issues?q=is%3Aissue+label%3Ainstallation installation issues] in the bug tracker to check if your error message was already reported.
If it was not reported yet, open a new issue and copy the error message from the Blender console (on Windows, click Window -> Toggle System Console in Blender's menu. On Linux, start Blender from a terminal and try to enable the addon, then copy the error message from the terminal).

See the [[BlendLuxCore_Installation | installation page]] for information on how to install, update and remove the BlendLuxCore addon.

=== Is there something like Cycles' Layer Weight/Fresnel/Facing node in LuxCore? ===

No, in LuxCore there is no direct equivalent to this node, because it would not work with the many algorithms in LuxCore that trace rays from lights (instead of from the camera), like the bidirectional engine, light tracing mode, or the PhotonGI cache.

Of course, all materials in LuxCore are physically based and have realistic fresnel effects built-in.

You can achieve a similar effect with the dot product node, but it will work only for one viewpoint:

[[File:Layer_weight_for_one_direction.PNG | thumb | 400px | center]]

=== Can Cycles materials be used in BlendLuxCore? ===

To an extent, yes. Many common Cycles shader nodes can be used in BlendLuxCore:

* You can enable this individually for each material with the "Use Cycles Nodes" option in the material properties.
* You can also enable it for the whole scene at once with the "Use Cycles Settings" button in the render properties. This will configure all materials, lights and the world to use Cycles settings

Not all Cycles nodes and settings are supported. Here is an overview: https://github.com/LuxCoreRender/BlendLuxCore/issues/272

=== Can 2D/3D mapping be driven by textures in LuxCore? ===

In general, no, because it would lead to much worse performance on GPUs.

However, if you only need to drive the translation part of a texture mapping, since LuxCore v2.5 you can use the distort texture for this purpose:

[[File:Distort_texture.PNG | thumb | 400px | center | A checker texture (left) is distorted by a clouds texture (right). The result can be seen in the center]]

Texturing of rotation and scale is not yet possible.

=== What can be done against fireflies/hotpixels? ===

Sometimes, pixels appear that are much brighter than the surrounding pixels. Sometimes they are singular, sometimes clumped up. The underlying reason are light paths that are correct, but very hard to find with the current rendering algorithms, and thus they take much longer to render until noise-free than all other light paths in the image.

There are multiple ways to approach this problem:

* '''Try another rendering algorithm''', it might be able to find the firefly-causing light paths much easier than the one you currently use. For example, try going to the render properties, open the Light Paths panel and enable "Light Tracing", or try the [[PhotonGI | PhotonGI caustic cache]], or try using the bidirectional engine.
* You can '''clamp the brightness of all light paths''' to a maximum value, in the render properties, Light Paths panel, "Clamping" setting. BlendLuxCore can auto-detect a value for this setting that is in the right ballpark for your scene if you render once without clamping enabled, but often this value will not be the best, so you will need a bit of trial-and-error to find a good value. Note that the clamping value depends on the lighting in your scene, so there is no one universally good clamping value, and you might need to adjust it if you add a new light source to your scene that is brighter than the others. Using a clamping value that is too low will result in a low-contrast, washed-out image, while a too high value will leave fireflies unaffected.
* Try to find out which lights or materials are responsible for the fireflies. There might be small, hard-to-find light sources that are causing them. Or a specular material is reflecting such a light source. If you are willing to alter the look of the scene, you can make such a light source more visible/larger, or lower the specularity of such a material. You can also make some light sources invisble to indirect light rays, thus eliminating fireflies (light properties, "Visibility" panel). This can be a good idea for the sun, for example, if your scene contains lots of specular materials.

=== Why is my HDRI environment black and not showing up? ===
You probably have other very bright light sources in the scene, for example a sun or a sky lamp.

'''Solution:''' raise the gain value of the area or HDRI light source that is black. The gain value might need to be very high, e.g. 100000.

=== Why is my area lamp black? ===
See [[#"Why is my HDRI environment black and not showing up?"]]

=== When I change the brightness of my lamp, nothing happens ===

You are probably using an automatic tonemapper which adjusts itself to the changed brightness, making it seem like the brightness did not change.

'''Solution:''' Use a non-automatic tonemapper (camera settings -> [[ImagePipeline]]).


=== When I make one of my lights brighter, all the other lights get darker (or vice versa) ===

Similar to [[#"When I change the brightness of my lamp, nothing happens"]]. 
You are using an automatic tonemapper which tries to keep the image at the same brightness, making it seem like the brightness of the lamps changed.

'''Solution:''' Use a non-automatic tonemapper (camera settings -> [[ImagePipeline]]).


=== A material/object appears to be flickering when I move the camera and shows artifacts in final render ===

This effect is called [https://en.wikipedia.org/wiki/Z-fighting Z-fighting] and is usually caused by mesh faces being exactly on top of each other, e.g. two planes on the same world coordinates.

'''Solution:'''
* Check if there are two objects on top of each other, e.g. because you duplicated the object, cancelled the transform and forgot about it.
* Check if the mesh has duplicate faces. Enter edit mode and use the Remove Doubles button in the Tools panel, which might solve the problem in some cases.
Duplicate faces are often caused by extruding, cancelling the transform and forgetting about it.

=== There are dark triangular artifacts on my model, and I already checked for duplicate faces ===

Floating point numbers have a limited precision. When objects are very large (kilometers) or very small (micrometers), these precision issues become visible.

'''Solution:'''
* If the object has a "normal" size (something like 1 cm to 1 km), but was scaled up/down by a huge amount, try to apply the scale (Ctrl+A -> Scale). For example, this often happens with imported CAD models.
* If applying the scale did not help and your object has to be very small or large, consider to bring it into the normal scale mentioned above, and pretend that it has a larger/smaller size. For example, if you make a model of the solar system, you will just have to make the earth something like 12.742 m in diameter, and pretend that 1 m of your model is equal to 10^6 m.
* If both options above are not usable in your case, you can raise the minimum epsilon that LuxCore uses. This setting can be found in the scene properties, Units panel, after clicking "Advanced LuxCore Settings". By default, the minimum epsilon is 0.00001. Try to raise it to 0.0001 (multiply by 10) for a start and see if the artifacts disappear. Do not set this value higher than necessary, because it will cause all sorts of hard-to-track problems. Be especially careful if you are rendering a scene with volumes.

=== An object that I set to "smooth shading" looks like it is shaded flat in shadow penumbras ===

This artifact is called "terminator problem".

'''Solution:''' Unfortunately there is no real solution. You can only try to mitigate the effect by subdividing the geometry further and/or increase the size of the light source that is causing the problem.

=== How do I setup liquid in a glass container correctly? ===

This forum thread shows an example: https://forums.luxcorerender.org/viewtopic.php?f=4&t=728#p7550

=== Can I export my scene in LuxCore format to render it in LuxCore standalone? ===

Yes. In the render properties, LuxCore Tools panel, enable "FileSaver". Then render with F12.

=== How can I compile kernels from the command line? ===
Here is a way to compile kernels from the command line (out of Blender), for the latest version of pyluxcore:
<pre>
pip install pyluxcore --upgrade
python -c "import pyluxcore; pyluxcore.Init(); pyluxcore.KernelCacheFill()"
</pre>

= Getting Help =

If none of the above entries helped to solve your problem, consider asking in the [https://forums.luxcorerender.org/viewforum.php?f=4 user support forum] or [https://forums.luxcorerender.org/viewtopic.php?f=4&t=2 filing a bug report].

[[Category:BlendLuxCore]]

LuxCoreRender Release Notes v2.11

2025-07-02T10:19:43Z

CodeHD: /* BlendLuxCore */

= BlendLuxCore =

* Fresnel texture: "custom n,k" now accepts values > 1
* Change installation mechanism to use bpy.utils.extension_path_user() INCOMPLETE
* Include "OptiX" in addon settings label to avoid user questions about compatibility
* Added a workaround for a Blender bug that throws an error when Blender is closed
* Added a linux development shell script (optional utility for developers)
* Remove löeftover code from the Addons system that is no longer used with the Extensions system.

= LuxCore =
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement

= LuxCoreDeps =
* Dependencies updated to latest versions
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.

LuxCoreRender Release Notes v2.10

2025-07-02T10:15:26Z

CodeHD: Added section for bugfix release v2.10.1

__TOC__

=Bugfix release v2.10.1=

===LuxCore===
* Fixed a bug in luxcoreui (crash when loading a new .cfg file)
* Pin nvrtc dependency of pyluxcore to a specific version

===BlendLuxCore===
* Added a workaround for a Blender bug that throws an error when Blender is closed
* Added a linux development shell script (optional utility for developers)

=LuxCore=

===New Features===

* New, multiplatform dependency manager: LuxCoreDeps. The new dep manager is based on Conan, an open source software which gives access to a database of thousands of build recipes, maintained up-to-date both by a company (JFrog) and a dynamic community. The deps are now built from sources, for a better control of build settings, binary compatibility etc.

* Dependencies updated to latest versions

* Buildability restored for all previous platforms: Linux, Windows, MacOS Intel

* Buildability added MacOS ARM platform.

* LuxCoreRender delivered in the form of Python wheels, published on PyPi.

* Automation (check, build, publish...) rewritten in Github Actions

===Fixed Bugs===

* LuxCore is now buildable again, on all previous platforms (Linux, Windows, MacOS Intel) + one (MacOS ARM).
* Crash fixed on tile path

===Known Problems===

= BlendLuxCore =

===New Features===
* Compatibility for Blender 4.2 and 4.3
* Partial compatibility for Blender 4.4 (not a release goal)
* Moved from Blenders addon system to the new extension system
* BlendLuxCore no longer bundles LuxCore binaries, platform specific binaries now distributed via PyPi
* Changed build pipeline from Azure to GitHub CI/CD
* Add square-root option to math node (alias to power 0.5)
* Add a setting to suppress LuxCore console log output
* Glass material now accepts IOR < 1
* Materials can now be individually excluded from material override
* BlendLuxCore specific menus are marked with an icon

===Fixed Bugs===
* Motion blur support for instances
* Improve custom normals export time by utilizing mesh.loops.foreach_get()
* LOL: Changed data access to adapt to new webhosting requirements

===Known Problems===
* Crashes are observed on macOS with Blender 4.2 and Blender 4.3. Related to window resizing and render completion. Unknown if Blender specific or also happening in standalone.
* Motion blur does not seem to work on "deeper iterations", e.g. copying an instanced object

Developing and debugging BlendLuxCore

2025-06-12T11:47:25Z

CodeHD: /* Tips & Tricks */

= Introduction =

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path _folder containing_ the development repo of BlendLuxCore

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed python module. A development version of the wheel can be copied into this folder.

These methods will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path _folder containing_ the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set BLC_DEV_PATH to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precendence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Utility shell script for launching Blender ==

The BlendLuxCore repository contains a shell script, called <code>blendev</code> (short for blender-development), located inside the <code>debug-helpers</code> subdirectory.
The purpose of this script is to easily launch Blender and switch between multiple versions of Blender, a regularly installed version of BlendLuxCore and pyluxcore, local development code of BlendLuxCore, and locally compiled versions of pyluxcore.
At the time of writing, this script is available only for linux/bash development.

Please see the <code>Readme.md</code> supplied alongside the script, and its internal help output <code>blendev -h</code> for detailed instructions on how to use it.

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore

LuxCoreRender Wiki

2025-06-12T11:35:27Z

CodeHD: /* Documentation */

__NOTOC__
== Users ==

=== Documentation ===
* [[ BlendLuxCore_Installation | BlendLuxCore Installation]]
* [[ BlendLuxCore_FAQ | BlendLuxCore FAQ]]
* [[ LuxCoreRender_Tutorials | Tutorials ]]
* [[ LuxCoreRender_User%27s_Manual | LuxCoreRender User's Manual]]
* [[ :Category:BlendLuxCore | Blender Addon User's Manual ]]
* [[ PyLuxCoreTools | Command Line Tools ]]
* [[ LuxMark | LuxMark Benchmark]]

=== Useful links ===

* [https://luxcorerender.org/ ''LuxCoreRender Home Page'']
* [https://forums.luxcorerender.org/ ''LuxCoreRender Forums'']
* [[ External_Resources | External Resources ]]
* [[ Previous_Version | Previous Version (LuxRender) ]]

== Developers & Admins ==

=== Documentation ===

* [[ Building_LuxCoreRender | Building LuxCoreRender ]]
* [[ C++ Coding Guidelines ]]
* [[ Regular Maintenance Tasks ]]
* [[ Developing and debugging BlendLuxCore ]]
* [[ Compiling_LuxCore | Building LuxCoreRender (legacy) ]]
* [[ LuxCoreRender_Release_Notes | LuxCoreRender Release Notes ]]
* [[ LuxCore_API | LuxCore API ]]
* [[ LuxCore_API_Reference_Manual | LuxCore API Reference Manual]]
* [[ LuxCore_SDL_Reference_Manual | LuxCore SDL Reference Manual ]]

=== MaxToLux Documentation ===

* [[ MaxToLux_Plugin_Release_Notes | MaxToLux Plugin Release Notes]]
* [[ MaxToLux_Plugin_Reference_Manual | MaxToLux Plugin Reference Manual]]

=== Tutorials ===

* [[ Writing_an_Imagepipeline_Plugin | How to Write an Imagepipeline Plugin ]]
* [[ Implementing_a_Texture | How to Implement a Texture ]]

=== Information for Wiki Editors ===

We had to close the wiki registration because of too many spambots. 
If you want to contribute to the wiki, please request an account in our [https://forums.luxcorerender.org/viewforum.php?f=10 general discussion forum].

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

LuxCoreRender Release Notes v2.11

2025-06-10T05:44:04Z

CodeHD: /* BlendLuxCore */

= BlendLuxCore =

* Fresnel texture: "custom n,k" now accepts values > 1

= LuxCore =
* Reduction of Boost footprint, replaced with standard equivalents available in C++20.
* For the need of previous point: replacement of apple-clang by clang 20 on MacOS platforms
* New target 'wheel-test' that builds a testing wheel in local build (<code>make wheel-test</code>)
* Requirement checking in <code>make deps</code>
* luxrays: rename GetConfigDir as GetCacheDir and use XDG_CACHE_HOME according to specifications (@illwieckz)
* Subdivision: add an "adaptive" setting to select between adaptive refinement and uniform refinement

= LuxCoreDeps =
* Dependencies updated to latest versions
* Removed a workaround introduced in previous version (we used to build a fake wheel to get containerization)
* OpenMP - MacOS: Use of homebrew OpenMP (up-to-date, compatible with clang 20) rather than Conan llvm-openmp (version 17...). As a consequence, for MacOS Intel, a version >= 13.0 is required.
* Opensubdiv: tbb activation. As a consequence, for MacOS Arm, a version >= 14.2 is required.
* OpenImageIO: deactivation of several image formats that seem unrelated to or unsupported by LuxCore: freetype, hdf5, ffmpeg, libheif, ptex, opencv, webp. This removal spares both compilation time and build result size. Those formats are reactivable, in case they were missing.
* OpenImageIO: To the contrary, activation of tbb option.

Developing and debugging BlendLuxCore

2025-06-09T18:28:21Z

CodeHD: /* Scenario #2: Working on pyluxcore */

= Introduction =

== Goal and audience ==
This document explains the approach to install a development version of BlendLuxCore (BLC) in Blender, so that it's possible to test and debug it. 
The targeted audience encompasses:
* BlendLuxCore development contributors
* BlendLuxCore advanced users/alpha testers who have been provided a dev version of BLC, in order to test a new feature.
* LuxCore developers who want to use Blender as a tool to test changes to the core engine.

== Statement of problem ==
BlendLuxCore (BLC) is composed of two parts:
* A Python module, essentially identical to the [https://github.com/LuxCoreRender/BlendLuxCore BlendLuxCore] repository.
* Underlying pyluxcore library, compiled from the [https://github.com/LuxCoreRender/LuxCore LuxCore] repository. Typically distributed as a Python wheel.

The python module is distributed as a zip-file, which is installed in Blender as an extension. During the installation process, the pyluxcore-wheel is downloaded from PyPi. During subsequent startup of Blender, the python script verifies the presence of pyluxcore and an additional (time-consuming) download is not necessary.

However, when developing BLC, we typically need to:
* Make Blender load a development version of the python module
* And optionally make BLC load a development version of the pyluxcore-wheel

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path _folder containing_ the development repo of BlendLuxCore

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed python module. A development version of the wheel can be copied into this folder.

These methods will be explained in detail in the sections below.

= Prerequisites =
In the next parts of the document, we shall assume:

You have set a development environment on your local computer with:
* a cloned repository of BlendLuxCore
* and optionally a cloned repository of LuxCore

You know how to "pack" BlendLuxCore, ie build an installable package of BLC:
<pre>
cmake -S . -B out -DCMAKE_BUILD_TYPE=Release
cmake --build out
</pre>

You know how to build a test wheel from LuxCore:
<pre>
make wheel-test
</pre>

= Scenario #1: Working on BLC, using standard pyluxcore =

The first goal can be achieved via an environment variable:
* <code>BLC_DEV_PATH</code>: path _folder containing_ the development repo of BlendLuxCore

In the environment where you run Blender, and BlendLuxCore has already been installed using the normal installation method, set BLC_DEV_PATH to the path of your dev repository:
<pre>export BLC_DEV_PATH=/path/to/folder/containing/BlendLuxCore</pre>
For clarification, set this folder like you would set the systems <code>PATH</code> or <code>PYTHONPATH</code> variable, i.e. so that python can <code>import BlendLuxCore</code> from this location!

When this variable is set, all python code from the development repo will be loaded, except the main <code>__init__.py</code> file. Changes to the latter may require a full reinstallation of BlendLuxCore, depending on what was changed.

As a verification of this working correctly, the console output of Blender at startup will show the following line: 
<code>[BLC] USING LOCAL DEV VERSION OF BlendLuxCore</code>

= Scenario #2: Working on pyluxcore =

For the second goal, two methods are available:
* Another environment variable, <code>BLC_WHEEL_PATH</code>: path to a development version of the wheel
* A subfolder <code>pyluxcore_custom/</code> within the installed python module. A development version of the wheel can be copied into this folder.
Note that the presence of a file inside <code>pyluxcore_custom/</code> will take precendence over the <code>BLC_WHEEL_PATH</code> variable!
To simplify further explanations, all explanations are presented in terms of the <code>BLC_WHEEL_PATH</code> variable.

When this variable is set, BLC computes a hash of the linked wheel. This hash is compared against information stored in the file <code>pyluxcore_installation_info.txt</code>, located within the installed python module. If the information matches, installation is skipped. Else, if it does not match, the local pyluxcore-wheel will be installed, replacing the previous version.
The text file also stores information if the previous installation was from PyPi or from a local wheel. This means, when the environment variable is unset after testing, it will again be replaced with the regular version from PyPi.

As a verification, check for the following lines in the console output of Blender at startup: 
<code>[BLC] Installing local version of pyluxcore</code> --> A new local version will be installed. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed.</code> --> A local version was previously installed and is used again. 
<code>[BLC] installing pyluxcore version:</code> --> pyluxcore will be installed from PyPi. Replaces any previous installation. 
<code>[BLC] skipping pyluxcore installation. Specified version already installed.</code> --> A PyPi version was previously installed and is used again.

(Note: Further error messages exist but they are out of the scope of this article.)

= Tips & Tricks =

== Useful directories ==

The extension is installed in: 
<code>$HOME/.config/blender/<blender-version>/extensions/user_default</code>

The wheel is installed in: 
<code>$HOME/.config/blender/<blender version>/extensions/.local/lib/python<python-version>/site-packages</code>

== Wheel not loading - Python version mismatch between System and Blender ==

You may work in an environment where the version of the system-wide Python interpreter is different from that of Blender's embedded interpreter. This can happen, for instance, if your OS is ArchLinux. System-wide Python will be the latest version available (say, 3.13), whereas Blender interpreter will be an older one (for instance, 3.11).

If you build a test wheel without precaution, the tag will be the one of your system-wide Python and, when you try to install it in Blender, _the embedded interpreter will prevent you to do so (or will prevent you to import the lib)_.

The most simple workaround consists in using <code>pyenv</code> to set the right interpreter in your build session. Be careful to clear and reconfigure the whole project, afterwards: <pre>make clear && make deps</pre>

Once rebuilt, please check the version of pyluxcore in the build log:
<code>LuxCore/out/install/Debug/pyluxcore/pyluxcore.cpython-<version>-x86_64-linux-gnu.so</code>

<version> should match with the embedded interpreter.

Another point to be cautious about, in the present case: if pyluxcore is already installed system-wide, for a different version of Python than Blender, then Blender will fail installing the wheel. In this case, you'll have to uninstall your system-wide pyluxcore (<code>pip uninstall pyluxcore</code>) if you want Blender to install correctly.

== Message "[BLC] skipping pyluxcore installation. Custom wheel matching hash already installed." ==

If you think this message is irrelevant, clean the following file: <code>$HOME/.config/blender/4.2/extensions/.user/user_default/BlendLuxCore/pyluxcore_installation_info.txt</code>

== Debugging the wheel executing in Blender (Linux) ==

It is possible to debug the wheel when it is executed in Blender. To do so, follow the procedure below:
* Build the wheel in debug mode:
<pre>export LUX_BUILD_TYPE=Debug
make wheel-test</pre>

* Run Blender with gdb
<pre>gdb --args blender</pre>

(nota bene: check that the latest wheel is correctly installed by BlendLuxCore)

gdb should allow you to debug any call to LuxCore