godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/LightmapGIData.xml

52 lines
1.4 KiB
XML
Raw Normal View History

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" ?>
Rename GI Classes * GIProbe is now VoxelGI * BakedLightmap is now LightmapGI As godot adds more ways to provide GI (as an example, SDFGI in 4.0), the different techniques (which have different pros/cons) need to be properly named to avoid confusion.
2021-06-04 22:47:26 +00:00
<class name="LightmapGIData" inherits="Resource" version="4.0">
doc: Sync classref with current source Adds API changes from the new GPU lightmapper.
2020-05-12 08:10:34 +00:00
<brief_description>
</brief_description>
<description>
</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" />
<argument index="0" name="path" type="NodePath" />
<argument index="1" name="uv_scale" type="Rect2" />
<argument index="2" name="slice_index" type="int" />
<argument 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>
</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>
</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>
</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" />
<argument 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>
</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>
</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" />
<argument 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>
</description>
</method>
</methods>
<members>
<member name="light_texture" type="TextureLayered" setter="set_light_texture" getter="get_light_texture">
</member>
</members>
</class>