godot/doc/classes/LightmapGIData.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="LightmapGIData" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Contains baked lightmap and dynamic object probe data for [LightmapGI].
	</brief_description>
	<description>
		[LightmapGIData] contains baked lightmap and dynamic object probe data for [LightmapGI]. It is replaced every time lightmaps are baked in [LightmapGI].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_user">
			<return type="void" />
			<param index="0" name="path" type="NodePath" />
			<param index="1" name="uv_scale" type="Rect2" />
			<param index="2" name="slice_index" type="int" />
			<param index="3" name="sub_instance" type="int" />
			<description>
				Adds an object that is considered baked within this [LightmapGIData].
			</description>
		</method>
		<method name="clear_users">
			<return type="void" />
			<description>
				Clear all objects that are considered baked within this [LightmapGIData].
			</description>
		</method>
		<method name="get_user_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of objects that are considered baked within this [LightmapGIData].
			</description>
		</method>
		<method name="get_user_path" qualifiers="const">
			<return type="NodePath" />
			<param index="0" name="user_idx" type="int" />
			<description>
				Returns the [NodePath] of the baked object at index [param user_idx].
			</description>
		</method>
		<method name="is_using_spherical_harmonics" qualifiers="const">
			<return type="bool" />
			<description>
				If [code]true[/code], lightmaps were baked with directional information. See also [member LightmapGI.directional].
			</description>
		</method>
		<method name="set_uses_spherical_harmonics">
			<return type="void" />
			<param index="0" name="uses_spherical_harmonics" type="bool" />
			<description>
				If [param uses_spherical_harmonics] is [code]true[/code], tells the engine to treat the lightmap data as if it was baked with directional information.
				[b]Note:[/b] Changing this value on already baked lightmaps will not cause them to be baked again. This means the material appearance will look incorrect until lightmaps are baked again, in which case the value set here is discarded as the entire [LightmapGIData] resource is replaced by the lightmapper.
			</description>
		</method>
	</methods>
	<members>
		<member name="light_texture" type="TextureLayered" setter="set_light_texture" getter="get_light_texture">
			The lightmap atlas texture generated by the lightmapper.
		</member>
	</members>
</class>
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="LightmapGIData" inherits="Resource" version="4.0" 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 08:10:34 +00: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 20:29:22 +00:00			`Contains baked lightmap and dynamic object probe data for [LightmapGI].`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</brief_description>`
			`<description>`
Document LightmapGI, LightmapGIData and LightmapProbe This documents those 3 classes with 100% completion, while also documenting the relevant project settings. 2022-06-10 20:29:22 +00:00			`[LightmapGIData] contains baked lightmap and dynamic object probe data for [LightmapGI]. It is replaced every time lightmaps are baked in [LightmapGI].`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="add_user">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="path" type="NodePath" />`
			`<param index="1" name="uv_scale" type="Rect2" />`
			`<param index="2" name="slice_index" type="int" />`
			`<param index="3" name="sub_instance" type="int" />`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`<description>`
Document LightmapGI, LightmapGIData and LightmapProbe This documents those 3 classes with 100% completion, while also documenting the relevant project settings. 2022-06-10 20:29:22 +00:00			`Adds an object that is considered baked within this [LightmapGIData].`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</description>`
			`</method>`
			`<method name="clear_users">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="void" />`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`<description>`
Fix various typos not caught by codespell Revert upstream `core/input/gamecontrollerdb.txt`. Upstream fix: https://github.com/gabomdq/SDL_GameControllerDB/pull/600 2022-07-21 11:37:00 +00:00			`Clear all objects that are considered baked within this [LightmapGIData].`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</description>`
			`</method>`
			`<method name="get_user_count" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="int" />`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`<description>`
Document LightmapGI, LightmapGIData and LightmapProbe This documents those 3 classes with 100% completion, while also documenting the relevant project settings. 2022-06-10 20:29:22 +00:00			`Returns the number of objects that are considered baked within this [LightmapGIData].`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</description>`
			`</method>`
			`<method name="get_user_path" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="NodePath" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="user_idx" type="int" />`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`<description>`
[doc] Use "param" instead of "code" to refer to parameters (5) 2022-08-12 13:36:48 +00:00			`Returns the [NodePath] of the baked object at index [param user_idx].`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</description>`
			`</method>`
			`<method name="is_using_spherical_harmonics" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`<description>`
Document LightmapGI, LightmapGIData and LightmapProbe This documents those 3 classes with 100% completion, while also documenting the relevant project settings. 2022-06-10 20:29:22 +00:00			`If [code]true[/code], lightmaps were baked with directional information. See also [member LightmapGI.directional].`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</description>`
			`</method>`
			`<method name="set_uses_spherical_harmonics">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="uses_spherical_harmonics" type="bool" />`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`<description>`
[doc] Use "param" instead of "code" to refer to parameters (5) 2022-08-12 13:36:48 +00:00			`If [param uses_spherical_harmonics] is [code]true[/code], tells the engine to treat the lightmap data as if it was baked with directional information.`
Document LightmapGI, LightmapGIData and LightmapProbe This documents those 3 classes with 100% completion, while also documenting the relevant project settings. 2022-06-10 20:29:22 +00:00			`[b]Note:[/b] Changing this value on already baked lightmaps will not cause them to be baked again. This means the material appearance will look incorrect until lightmaps are baked again, in which case the value set here is discarded as the entire [LightmapGIData] resource is replaced by the lightmapper.`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</description>`
			`</method>`
			`</methods>`
			`<members>`
			`<member name="light_texture" type="TextureLayered" setter="set_light_texture" getter="get_light_texture">`
Document LightmapGI, LightmapGIData and LightmapProbe This documents those 3 classes with 100% completion, while also documenting the relevant project settings. 2022-06-10 20:29:22 +00:00			`The lightmap atlas texture generated by the lightmapper.`
doc: Sync classref with current source Adds API changes from the new GPU lightmapper. 2020-05-12 08:10:34 +00:00			`</member>`
			`</members>`
			`</class>`