2017-12-16 20:34:16 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-07-31 20:13:10 +02:00
<class name= "BakedLightmap" inherits= "VisualInstance" category= "Core" version= "3.0.7" >
2017-12-16 20:34:16 +01:00
<brief_description >
2018-08-19 06:29:12 +02:00
Prerendered indirect light map for a scene.
2017-12-16 20:34:16 +01:00
</brief_description>
<description >
2018-08-19 06:29:12 +02:00
Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the [GIProbe] approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time.
2017-12-16 20:34:16 +01:00
</description>
<tutorials >
2018-01-25 09:03:59 +01:00
http://docs.godotengine.org/en/3.0/tutorials/3d/baked_lightmaps.html
2017-12-16 20:34:16 +01:00
</tutorials>
<demos >
</demos>
<methods >
<method name= "bake" >
<return type= "int" enum= "BakedLightmap.BakeError" >
</return>
<argument index= "0" name= "from_node" type= "Node" default= "null" >
</argument>
<argument index= "1" name= "create_visual_debug" type= "bool" default= "false" >
</argument>
<description >
</description>
</method>
<method name= "debug_bake" >
<return type= "void" >
</return>
<description >
</description>
</method>
</methods>
<members >
2018-01-03 13:45:03 +01:00
<member name= "bake_cell_size" type= "float" setter= "set_bake_cell_size" getter= "get_bake_cell_size" >
2018-08-19 06:29:12 +02:00
Grid subdivision size for lightmapper calculation. Default value of [code]0.25[/code] will work for most cases. Increase for better lighting on small details or if your scene is very large.
2017-12-16 20:34:16 +01:00
</member>
2018-01-03 13:45:03 +01:00
<member name= "bake_energy" type= "float" setter= "set_energy" getter= "get_energy" >
</member>
<member name= "bake_extents" type= "Vector3" setter= "set_extents" getter= "get_extents" >
2018-08-19 06:29:12 +02:00
Size of affected area.
2017-12-16 20:34:16 +01:00
</member>
2018-01-03 13:45:03 +01:00
<member name= "bake_hdr" type= "bool" setter= "set_hdr" getter= "is_hdr" >
2018-08-19 06:29:12 +02:00
If [code]true[/code] lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code].
2017-12-16 20:34:16 +01:00
</member>
2018-01-03 13:45:03 +01:00
<member name= "bake_mode" type= "int" setter= "set_bake_mode" getter= "get_bake_mode" enum= "BakedLightmap.BakeMode" >
2018-08-19 06:29:12 +02:00
Lightmapping mode. See [enum BakeMode].
2017-12-16 20:34:16 +01:00
</member>
2018-01-03 13:45:03 +01:00
<member name= "bake_propagation" type= "float" setter= "set_propagation" getter= "get_propagation" >
2017-12-16 20:34:16 +01:00
</member>
2018-01-03 13:45:03 +01:00
<member name= "bake_quality" type= "int" setter= "set_bake_quality" getter= "get_bake_quality" enum= "BakedLightmap.BakeQuality" >
2018-08-19 06:29:12 +02:00
Three quality modes are available. Higher quality requires more rendering time. See [enum BakeQuality].
2017-12-16 20:34:16 +01:00
</member>
2018-01-03 13:45:03 +01:00
<member name= "capture_cell_size" type= "float" setter= "set_capture_cell_size" getter= "get_capture_cell_size" >
2018-08-19 06:29:12 +02:00
Grid size used for real-time capture information on dynamic objects. Cannot be larger than [member bake_cell_size].
2017-12-16 20:34:16 +01:00
</member>
<member name= "image_path" type= "String" setter= "set_image_path" getter= "get_image_path" >
2018-08-19 06:29:12 +02:00
Location where lightmaps will be saved.
2017-12-16 20:34:16 +01:00
</member>
<member name= "light_data" type= "BakedLightmapData" setter= "set_light_data" getter= "get_light_data" >
2018-08-19 06:29:12 +02:00
The calculated light data.
2017-12-16 20:34:16 +01:00
</member>
</members>
<constants >
<constant name= "BAKE_QUALITY_LOW" value= "0" enum= "BakeQuality" >
2018-08-19 06:29:12 +02:00
Lowest bake quality mode. Fastest to calculate.
2017-12-16 20:34:16 +01:00
</constant>
<constant name= "BAKE_QUALITY_MEDIUM" value= "1" enum= "BakeQuality" >
2018-08-19 06:29:12 +02:00
Default bake quality mode.
2017-12-16 20:34:16 +01:00
</constant>
<constant name= "BAKE_QUALITY_HIGH" value= "2" enum= "BakeQuality" >
2018-08-19 06:29:12 +02:00
Highest bake quality mode. Takes longer to calculate.
2017-12-16 20:34:16 +01:00
</constant>
<constant name= "BAKE_MODE_CONE_TRACE" value= "0" enum= "BakeMode" >
2018-08-19 06:29:12 +02:00
Less precise but faster bake mode.
2017-12-16 20:34:16 +01:00
</constant>
<constant name= "BAKE_MODE_RAY_TRACE" value= "1" enum= "BakeMode" >
2018-08-19 06:29:12 +02:00
More precise bake mode but can take considerably longer to bake.
2017-12-16 20:34:16 +01:00
</constant>
2017-12-18 08:13:58 +01:00
<constant name= "BAKE_ERROR_OK" value= "0" enum= "BakeError" >
</constant>
<constant name= "BAKE_ERROR_NO_SAVE_PATH" value= "1" enum= "BakeError" >
</constant>
<constant name= "BAKE_ERROR_NO_MESHES" value= "2" enum= "BakeError" >
</constant>
<constant name= "BAKE_ERROR_CANT_CREATE_IMAGE" value= "3" enum= "BakeError" >
</constant>
<constant name= "BAKE_ERROR_USER_ABORTED" value= "4" enum= "BakeError" >
</constant>
2017-12-16 20:34:16 +01:00
</constants>
</class>