LuxCore SDL Reference Manual v2.1 - Revision history

Piita: /* Light sources */ fixed broken link to Luxcore Lighting

2019-04-20T09:12:35Z

Light sources: fixed broken link to Luxcore Lighting

← Older revision		Revision as of 11:12, 20 April 2019
Line 2,850:		Line 2,850:
	==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===

Byob: Undo revision 1439 by Byob (talk)

2019-04-15T01:30:25Z

Undo revision 1439 by Byob (talk)

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

	~~Outputs are enabled with the following properties~~:		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"

	~~{\| class="wikitable" cellspacing="2"~~		Note that the Bidir engine only supports a subset of AOVs.
	~~!Property name~~		The AOVs supported by Bidir are: "RADIANCE_GROUP", "SAMPLECOUNT", "ALPHA", "RGBA", "RGB", "DEPTH".
	~~!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:		This is the list of output channel data types and sizes:

Byob: Undo revision 1440 by Byob (talk)

2019-04-15T01:29:54Z

Undo revision 1440 by Byob (talk)

← Older revision		Revision as of 03:29, 15 April 2019
Line 669:		Line 669:
	\|'''film.outputs.<index>.type''' \|\| string \|\| \|\| Type of output, e.g. "RGBA" or "ALPHA" (see the list above for the available types)		\|'''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>.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''',~~<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>.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)~~<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		\|'''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
	\|}		\|}

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

2019-04-15T01:05:51Z

Film Outputs (aka AOVs)

← Older revision		Revision as of 03:05, 15 April 2019
Line 669:		Line 669:
	\|'''film.outputs.<index>.type''' \|\| string \|\| \|\| Type of output, e.g. "RGBA" or "ALPHA" (see the list above for the available types)		\|'''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>.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''', '''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>.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) 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		\|'''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
	\|}		\|}

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

2019-04-15T01:01:11Z

Film Outputs (aka AOVs)

← Older revision		Revision as of 03:01, 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 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:		This is the list of output channel data types and sizes:

Byob: /* Type: objectidcolor */

2018-10-17T10:51:26Z

Type: objectidcolor

← Older revision		Revision as of 12:51, 17 October 2018
Line 2,021:		Line 2,021:
	===Type: objectidcolor===		===Type: objectidcolor===

	Object ID interpreted as color.		Object ID interpreted as color.<br>
			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"		{\| class="wikitable" cellspacing="2"

Byob: /* Type: remap */

2018-10-17T10:48:51Z

Type: remap

← Older revision		Revision as of 12:48, 17 October 2018
Line 1,995:		Line 1,995:
	\|'''scene.textures.<texture name>.type''' \|\| string \|\| "remap" \|\| type of texture		\|'''scene.textures.<texture name>.type''' \|\| string \|\| "remap" \|\| type of texture
	\|-		\|-
	\|'''scene.textures.<texture name>.value''' \|\| texture \|\| 1.0 \|\| texture name or constant		\|'''scene.textures.<texture name>.value''' \|\| texture \|\| 0.5 \|\| texture name or constant
	\|-		\|-
	\|'''scene.textures.<texture name>.sourcemin''' \|\| texture \|\| 1.0 \|\| 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>.sourcemax''' \|\| texture \|\| 1.0 \|\| texture name or constant
	\|-		\|-
	\|'''scene.textures.<texture name>.targetmin''' \|\| 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		\|'''scene.textures.<texture name>.targetmax''' \|\| texture \|\| 1.0 \|\| texture name or constant

Byob: add divide, remap and object id texture descriptions

2018-10-17T10:47:55Z

add divide, remap and object id texture descriptions

@@ Line 1,962: / Line 1,962: @@
 |-
 |'''scene.textures.<texture name>.max''' || float || 1.0 || upper boundary of the clamping
 |}

Byob: /* Periodic save */

2018-09-30T22:45:42Z

Periodic save

← Older revision		Revision as of 00:45, 1 October 2018
Line 46:		Line 46:
	\|'''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.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''' \|\| ~~float~~ \|\| "resume.rsm" \|\| the name to use to save the rendering resume information periodically		\|'''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.period''' \|\| float \|\| 0 \|\| save the Film every specified amount of time (value in seconds). A value <= 0.0 disable the saving
	\|-		\|-
	\|'''periodicsave.film.filename''' \|\| ~~float~~ \|\| "film.flm" \|\| the name to use to save the film periodically		\|'''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		\|'''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

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

2018-09-19T12:26:56Z

Film Outputs (aka AOVs)

← Older revision		Revision as of 14:26, 19 September 2018
Line 729:		Line 729:
	\|-		\|-
	\|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
			\|-
			\|MATERIAL_ID_COLOR\|\|float\|\|film width x film height x 3\|\|Material ID converted to colors (with anti-aliasing)
	\|}		\|}