virtualx-engine/doc/classes/LightmapProbe.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="LightmapProbe" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Represents a single manually placed probe for dynamic object lighting with [LightmapGI].
	</brief_description>
	<description>
		[LightmapProbe] represents the position of a single manually placed probe for dynamic object lighting with [LightmapGI]. Lightmap probes affect the lighting of [GeometryInstance3D]-derived nodes that have their [member GeometryInstance3D.gi_mode] set to [constant GeometryInstance3D.GI_MODE_DYNAMIC].
		Typically, [LightmapGI] probes are placed automatically by setting [member LightmapGI.generate_probes_subdiv] to a value other than [constant LightmapGI.GENERATE_PROBES_DISABLED]. By creating [LightmapProbe] nodes before baking lightmaps, you can add more probes in specific areas for greater detail, or disable automatic generation and rely only on manually placed probes instead.
		[b]Note:[/b] [LightmapProbe] nodes that are placed after baking lightmaps are ignored by dynamic objects. You must bake lightmaps again after creating or modifying [LightmapProbe]s for the probes to be effective.
	</description>
	<tutorials>
	</tutorials>
</class>
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 10:10:34 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="LightmapProbe" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 10:10:34 +02:00			`<brief_description>`
Document LightmapGI, LightmapGIData and LightmapProbe This documents those 3 classes with 100% completion, while also documenting the relevant project settings. 2022-06-10 22:29:22 +02:00			`Represents a single manually placed probe for dynamic object lighting with [LightmapGI].`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 10:10:34 +02:00			`</brief_description>`
			`<description>`
Clarify lightmap rebaking being required for LightmapProbe changes 2024-06-20 00:56:56 +02:00			`[LightmapProbe] represents the position of a single manually placed probe for dynamic object lighting with [LightmapGI]. Lightmap probes affect the lighting of [GeometryInstance3D]-derived nodes that have their [member GeometryInstance3D.gi_mode] set to [constant GeometryInstance3D.GI_MODE_DYNAMIC].`
Document LightmapGI, LightmapGIData and LightmapProbe This documents those 3 classes with 100% completion, while also documenting the relevant project settings. 2022-06-10 22:29:22 +02:00			`Typically, [LightmapGI] probes are placed automatically by setting [member LightmapGI.generate_probes_subdiv] to a value other than [constant LightmapGI.GENERATE_PROBES_DISABLED]. By creating [LightmapProbe] nodes before baking lightmaps, you can add more probes in specific areas for greater detail, or disable automatic generation and rely only on manually placed probes instead.`
Clarify lightmap rebaking being required for LightmapProbe changes 2024-06-20 00:56:56 +02:00			`[b]Note:[/b] [LightmapProbe] nodes that are placed after baking lightmaps are ignored by dynamic objects. You must bake lightmaps again after creating or modifying [LightmapProbe]s for the probes to be effective.`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 10:10:34 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`</class>`