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

68 lines
2.6 KiB
XML
Raw Normal View History

Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +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-03-16 22:01:02 +00:00
<class name="BakedLightmapData" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="path" type="NodePath" />
<argument index="1" name="lightmap" type="Resource" />
<argument index="2" name="lightmap_slice" type="int" />
<argument index="3" name="lightmap_uv_rect" type="Rect2" />
<argument index="4" name="instance" type="int" />
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<description>
</description>
</method>
Add options to reduce lightmaps disk usage. Added BakedLightmap.use_hdr and BakedLightmap.use_color properties that can reduce the flie size of lightmap texture at the expense of quality. Changed the denoiser to work in a single buffer, reducing RAM usage. Also added the `-mstackrealign` flag in the denoiser compilation for MinGW builds. This flag helped fix a bug in Embree, so I want to see if it will help fix GH #45296.
2021-02-15 11:32:31 +00:00
<method name="clear_data">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
Add options to reduce lightmaps disk usage. Added BakedLightmap.use_hdr and BakedLightmap.use_color properties that can reduce the flie size of lightmap texture at the expense of quality. Changed the denoiser to work in a single buffer, reducing RAM usage. Also added the `-mstackrealign` flag in the denoiser compilation for MinGW builds. This flag helped fix a bug in Embree, so I want to see if it will help fix GH #45296.
2021-02-15 11:32:31 +00:00
<description>
</description>
</method>
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="int" />
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<description>
</description>
</method>
<method name="get_user_lightmap" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Resource" />
<argument index="0" name="user_idx" type="int" />
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="NodePath" />
<argument index="0" name="user_idx" type="int" />
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<description>
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds" default="AABB( 0, 0, 0, 0, 0, 0 )">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="cell_space_transform" type="Transform" setter="set_cell_space_transform" getter="get_cell_space_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="cell_subdiv" type="int" setter="set_cell_subdiv" getter="get_cell_subdiv" default="1">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="energy" type="float" setter="set_energy" getter="get_energy" default="1.0">
Add a property to control the bounce indirect energy in BakedLightmap Higher values will make indirect lighting brighter. A value of 1.0 represents physically accurate behavior, but higher values can be used to make indirect lighting propagate more visibly when using a low number of bounces. This can be used to speed up bake times by lowering the number of bounces then increasing the bounce indirect energy. Unlike BakedLightmapData's energy property, this property does not affect direct lighting emitted by light nodes or emissive materials.
2021-07-25 00:55:36 +00:00
Global energy multiplier for baked and dynamic capture objects. This can be changed at run-time without having to bake lightmaps again.
To adjust only the energy of indirect lighting (without affecting direct lighting or emissive materials), adjust [member BakedLightmap.bounce_indirect_energy] and bake lightmaps again.
Batch of lightmapper fixes and minor improvements - Fix objects with no material being considered as fully transparent by the lightmapper. - Added "environment_min_light" property: gives artistic control over the shadow color. - Fixed "Custom Color" environment mode, it was ignored before. - Added "interior" property to BakedLightmapData: controls whether dynamic capture objects receive environment light or not. - Automatically update dynamic capture objects when the capture data changes (also works for "energy" which used to require object movement to trigger the update). - Added "use_in_baked_light" property to GridMap: controls whether the GridMap will be included in BakedLightmap bakes. - Set "flush zero" and "denormal zero" mode for SSE2 instructions in the Embree raycaster. According to Embree docs it should give a performance improvement.
2021-03-11 12:34:57 +00:00
</member>
<member name="interior" type="bool" setter="set_interior" getter="is_interior" default="false">
Controls whether dynamic capture objects receive environment lighting or not.
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="octree" type="PoolByteArray" setter="set_octree" getter="get_octree" default="PoolByteArray( )">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
</members>
<constants>
</constants>
</class>