LuxCore SDL Reference Manual v2.2 - Revision history

Byob: /* Light Strategy */

2019-10-01T05:59:39Z

Light Strategy

@@ Line 504: / Line 504: @@
 !Description
 |-
-|'''lightstrategy.type''' || string || "LOG_POWER" || "UNIFORM", "POWER" or "LOG_POWER" || N/A || Direct light sampling strategy
+|'''lightstrategy.type''' || string || "LOG_POWER" || "UNIFORM", "POWER", "LOG_POWER" or "DLS_CACHE" || N/A || Direct light sampling strategy
 |}
@@ Line 518: / Line 518: @@
 "LOG_POWER" light strategy samples the light sources based on logarithm of their power.
 ==Accelerator==

Dade: /* Film Outputs (aka AOVs) */

2019-07-18T08:20:52Z

Film Outputs (aka AOVs)

← Older revision		Revision as of 10:20, 18 July 2019
Line 614:		Line 614:
	\|'''SHADING_NORMAL''' \|\| HDR		\|'''SHADING_NORMAL''' \|\| HDR
	\|-		\|-
	\|'''MATERIAL_ID''' \|\| ~~HDR/~~LDR		\|'''MATERIAL_ID''' \|\| LDR
	\|-		\|-
	\|'''DIRECT_DIFFUSE''' \|\| HDR		\|'''DIRECT_DIFFUSE''' \|\| HDR
Line 644:		Line 644:
	\|'''IRRADIANCE''' \|\| HDR		\|'''IRRADIANCE''' \|\| HDR
	\|-		\|-
	\|'''OBJECT_ID''' \|\| ~~HDR~~		\|'''OBJECT_ID''' \|\| LDR
	\|-		\|-
	\|'''OBJECT_ID_MASK''' \|\| HDR/LDR		\|'''OBJECT_ID_MASK''' \|\| HDR/LDR

Byob: /* Textures */

2019-05-09T11:01:24Z

Textures

@@ Line 2,178: / Line 2,178: @@
 |'''scene.textures.<texture name>.type''' || string || "position" || type of texture
 |}
 ===Type: blackbody===

Byob: /* Textures */ add new texture types: dotproduct, power, lessthan, greaterthan, shadingnormal, position

2019-04-26T20:59:39Z

Textures: add new texture types: dotproduct, power, lessthan, greaterthan, shadingnormal, position

@@ Line 2,083: / Line 2,083: @@
 |-
 |'''scene.textures.<texture name>.type''' || string || "objectidnormalized" || type of texture
 |}

Byob: /* Light sources */ apply Piita's fix

2019-04-26T20:50:11Z

Light sources: apply Piita's fix

← Older revision		Revision as of 22:50, 26 April 2019
Line 2,889:		Line 2,889:
	==Light sources==		==Light sources==

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

	===Common parameters===		===Common parameters===

Alpistinho at 16:52, 19 April 2019

2019-04-19T16:52:27Z

← Older revision		Revision as of 18:52, 19 April 2019
Line 653:		Line 653:
	\|-		\|-
	\|'''CONVERGENCE''' \|\| HDR/LDR		\|'''CONVERGENCE''' \|\| HDR/LDR
			\|-
			\|'''NOISE''' \|\| HDR/LDR
	\|-		\|-
	\|'''SERIALIZED_FILM''' \|\| N/A		\|'''SERIALIZED_FILM''' \|\| N/A
Line 742:		Line 744:
	\|-		\|-
	\|CONVERGENCE\|\|float\|\|film width x film height x 1\|\|The distance of each pixel from the convergence threshold		\|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		\|SERIALIZED_FILM\|\|N/A\|\|N/A\|\|The complete Film serialized in binary format
Line 1,145:		Line 1,149:
	!Description		!Description
	\|-		\|-
	\|'''batch.~~haltthreshold~~''' \|\| 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''' \|\| 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.~~haltthreshold~~.warmup''' \|\| unsigned int \|\| 64 \|\| number of average samples per pixel before to start the convergence test		\|'''batch.haltnoisethreshold.warmup''' \|\| unsigned int \|\| 64 \|\| number of average samples per pixel before to start the convergence test
	\|-		\|-
	\|'''batch.~~haltthreshold~~.step''' \|\| unsigned int \|\| 64 \|\| number of average samples per pixel between two tests		\|'''batch.haltnoisethreshold.step''' \|\| unsigned int \|\| 64 \|\| number of average samples per pixel between two tests
	\|-		\|-
	\|'''batch.~~haltthreshold~~.filter.enable''' \|\| bool \|\| 1 \|\| if the CONVERGENCE AOV (generated by the batch.~~haltthreshold~~) should be filtered or not with a 3x3 box filter		\|'''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.~~haltthreshold~~.stoprendering.enable''' \|\| bool \|\| 1 \|\| Set this to 0 (false) if you only want to use the ~~haltthreshold~~ settings for adaptive sampling in an endless render		\|'''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.halttime''' \|\| float \|\| 0.0 \|\| number of seconds before stopping the rendering		\|'''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		\|'''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.
			\|-
	\|}		\|}

Byob: /* Film Outputs (aka AOVs) */

2019-04-15T01:28:26Z

Film Outputs (aka AOVs)

← Older revision		Revision as of 03:28, 15 April 2019
Line 659:		Line 659:
	\|}		\|}

	~~Note~~: ~~'''MATERIAL_ID_MASK''', '''RADIANCE_GROUP''', '''BY_MATERIAL_ID''', '''OBJECT_ID_MASK''', '''BY_OBJECT_ID''' use an additional property, aside from ".type" and ".filename": ".id"~~		Outputs are enabled with the following properties:

	Note that the Bidir engine ~~only supports a subset of~~ AOVs.		{\| class="wikitable" cellspacing="2"
	~~The AOVs~~ supported by Bidir are: ~~"RADIANCE_GROUP"~~, ~~"SAMPLECOUNT"~~, ~~"ALPHA"~~, ~~"RGBA"~~, ~~"RGB"~~, ~~"DEPTH"~~.		!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<br> for HDR outputs and ".png" for LDR outputs (see list above for which output is HDR<br> and which LDR)
			\|-
			\|'''film.outputs.<index>.id''' \|\| int \|\| \|\| Specify for the following outputs: '''MATERIAL_ID_MASK''', '''RADIANCE_GROUP''',<br> '''BY_MATERIAL_ID''', '''OBJECT_ID_MASK''', '''BY_OBJECT_ID'''<br> (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)<br> to select the imagepipeline of the output. For example, if you have 3 imagepipelines defined,<br> and you want to specify the output of the third imagepipeline, use 2 for the ".index" property<br> 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:		This is the list of output channel data types and sizes:

Alpistinho: Initial version. Currently an exact copy of 2.1

2019-04-13T11:27:29Z

Initial version. Currently an exact copy of 2.1

Show changes