Re-extracted class docs.

Relintai · Jul 16, 2024 · 05dbe60 · 05dbe60
1 parent f9507dc
commit 05dbe60
Show file tree

Hide file tree

Showing 23 changed files with 652 additions and 38 deletions.
diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml
@@ -75,6 +75,13 @@
 				Returns the name of the blend shape at this index.
 			</description>
 		</method>
+		<method name="lightmap_unwrap">
+			<return type="int" enum="Error" />
+			<argument index="0" name="transform" type="Transform" />
+			<argument index="1" name="texel_size" type="float" />
+			<description>
+			</description>
+		</method>
 		<method name="regen_normalmaps">
 			<return type="void" />
 			<description>

diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="BakedLightmap" inherits="VisualInstance" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+<class name="BakedLightmap" inherits="VisualInstance" version="4.4">
 	<brief_description>
 		Prerendered indirect light map for a scene.
 	</brief_description>

diff --git a/doc/classes/BakedLightmapData.xml b/doc/classes/BakedLightmapData.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="BakedLightmapData" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+<class name="BakedLightmapData" inherits="Resource" version="4.4">
 	<brief_description>
 	</brief_description>
 	<description>

diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml
@@ -11,6 +11,12 @@
 	<tutorials>
 	</tutorials>
 	<methods>
+		<method name="convert_from_particles">
+			<return type="void" />
+			<argument index="0" name="particles" type="Node" />
+			<description>
+			</description>
+		</method>
 		<method name="get_param" qualifiers="const">
 			<return type="float" />
 			<argument index="0" name="param" type="int" enum="CPUParticles.Parameter" />

diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml
@@ -12,6 +12,12 @@
 		<link>$DOCS_URL/tutorials/2d/particle_systems_2d.md</link>
 	</tutorials>
 	<methods>
+		<method name="convert_from_particles">
+			<return type="void" />
+			<argument index="0" name="particles" type="Node" />
+			<description>
+			</description>
+		</method>
 		<method name="get_param" qualifiers="const">
 			<return type="float" />
 			<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />

diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml
@@ -281,6 +281,8 @@
 		<member name="editors/3d/grid_yz_plane" type="bool" setter="" getter="">
 			If [code]true[/code], render the grid on an YZ plane. This can be useful for 3D side-scrolling games.
 		</member>
+		<member name="editors/3d/lightmap_baking_number_of_cpu_threads" type="int" setter="" getter="">
+		</member>
 		<member name="editors/3d/navigation/emulate_3_button_mouse" type="bool" setter="" getter="">
 			If [code]true[/code], enables 3-button mouse emulation mode. This is useful on laptops when using a trackpad.
 			When 3-button mouse emulation mode is enabled, the pan, zoom and orbit modifiers can always be used in the 3D editor viewport, even when not holding down any mouse button.

diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GIProbe" inherits="VisualInstance" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+<class name="GIProbe" inherits="VisualInstance" version="4.4">
 	<brief_description>
 		Real-time global illumination (GI) probe.
 	</brief_description>

diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GIProbeData" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+<class name="GIProbeData" inherits="Resource" version="4.4">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -10,25 +10,25 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="bias" type="float" setter="set_bias" getter="get_bias" default="0.4">
+		<member name="bias" type="float" setter="set_bias" getter="get_bias" default="0.0">
 		</member>
-		<member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds" default="AABB( 0, 0, 0, 1, 1, 1 )">
+		<member name="bounds" type="AABB" setter="set_bounds" getter="get_bounds" default="AABB( 0, 0, 0, 0, 0, 0 )">
 		</member>
-		<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="1.0">
+		<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="0.0">
 		</member>
 		<member name="compress" type="bool" setter="set_compress" getter="is_compressed" default="false">
 		</member>
 		<member name="dynamic_data" type="PoolIntArray" setter="set_dynamic_data" getter="get_dynamic_data" default="PoolIntArray(  )">
 		</member>
-		<member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range" default="1">
+		<member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range" default="0">
 		</member>
-		<member name="energy" type="float" setter="set_energy" getter="get_energy" default="1.0">
+		<member name="energy" type="float" setter="set_energy" getter="get_energy" default="0.0">
 		</member>
 		<member name="interior" type="bool" setter="set_interior" getter="is_interior" default="false">
 		</member>
-		<member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias" default="0.4">
+		<member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias" default="0.0">
 		</member>
-		<member name="propagation" type="float" setter="set_propagation" getter="get_propagation" default="1.0">
+		<member name="propagation" type="float" setter="set_propagation" getter="get_propagation" default="0.0">
 		</member>
 		<member name="to_cell_xform" type="Transform" setter="set_to_cell_xform" getter="get_to_cell_xform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
 		</member>

diff --git a/doc/classes/GPUParticles.xml b/doc/classes/GPUParticles.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GPUParticles" inherits="GeometryInstance" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+<class name="GPUParticles" inherits="GeometryInstance" version="4.4">
 	<brief_description>
 		GPU-based 3D particle emitter.
 	</brief_description>

diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GPUParticles2D" inherits="Node2D" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+<class name="GPUParticles2D" inherits="Node2D" version="4.4">
 	<brief_description>
 		GPU-based 2D particle emitter.
 	</brief_description>

diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml
@@ -39,6 +39,10 @@
 		<member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin" default="0.0">
 			The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.
 		</member>
+		<member name="generate_lightmap" type="bool" setter="set_generate_lightmap" getter="get_generate_lightmap" default="true">
+		</member>
+		<member name="lightmap_scale" type="int" setter="set_lightmap_scale" getter="get_lightmap_scale" enum="GeometryInstance.LightmapScale" default="0">
+		</member>
 		<member name="material_overlay" type="Material" setter="set_material_overlay" getter="get_material_overlay">
 			The material overlay for the whole geometry.
 			If a material is assigned to this property, it will be rendered on top of any other active material for all the surfaces.
@@ -47,8 +51,20 @@
 			The material override for the whole geometry.
 			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.
 		</member>
+		<member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag" default="false">
+		</member>
 	</members>
 	<constants>
+		<constant name="LIGHTMAP_SCALE_1X" value="0" enum="LightmapScale">
+		</constant>
+		<constant name="LIGHTMAP_SCALE_2X" value="1" enum="LightmapScale">
+		</constant>
+		<constant name="LIGHTMAP_SCALE_4X" value="2" enum="LightmapScale">
+		</constant>
+		<constant name="LIGHTMAP_SCALE_8X" value="3" enum="LightmapScale">
+		</constant>
+		<constant name="LIGHTMAP_SCALE_MAX" value="4" enum="LightmapScale">
+		</constant>
 		<constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting">
 			Will not cast any shadows.
 		</constant>
@@ -64,9 +80,9 @@
 			Will only show the shadows casted from this object.
 			In other words, the actual mesh will not be visible, only the shadows casted from the mesh will be.
 		</constant>
-		<constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags">                                                                                                                       
-   		Will allow the GeometryInstance to be used when baking lights using a [GIProbe] or [BakedLightmap].                                                                               
-   	</constant>
+		<constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags">
+			Will allow the GeometryInstance to be used when baking lights using a [GIProbe] or [BakedLightmap].
+		</constant>
 		<constant name="FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="Flags">
 			Unused in this class, exposed for consistency with [enum RenderingServer.InstanceFlags].
 		</constant>

diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml
@@ -31,6 +31,8 @@
 		<member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only" default="false">
 			If [code]true[/code], the light only appears in the editor and will not be visible at runtime.
 		</member>
+		<member name="light_bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="Light.BakeMode" default="1">
+		</member>
 		<member name="light_color" type="Color" setter="set_color" getter="get_color" default="Color( 1, 1, 1, 1 )">
 			The light's color. An [i]overbright[/i] color can be used to achieve a result equivalent to increasing the light's [member light_energy].
 		</member>
@@ -119,8 +121,14 @@
 		<constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="15" enum="Param">
 			Constant for accessing [member DirectionalLight.directional_shadow_bias_split_scale].
 		</constant>
-		<constant name="PARAM_MAX" value="16" enum="Param">
+		<constant name="PARAM_MAX" value="17" enum="Param">
 			Represents the size of the [enum Param] enum.
 		</constant>
+		<constant name="BAKE_DISABLED" value="0" enum="BakeMode">
+		</constant>
+		<constant name="BAKE_INDIRECT" value="1" enum="BakeMode">
+		</constant>
+		<constant name="BAKE_ALL" value="2" enum="BakeMode">
+		</constant>
 	</constants>
 </class>
diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml
@@ -92,6 +92,10 @@
 			</description>
 		</method>
 	</methods>
+	<members>
+		<member name="lightmap_size_hint" type="Vector2i" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint" default="Vector2i( 0, 0 )">
+		</member>
+	</members>
 	<constants>
 		<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
 			Render array as points (one vertex equals one point).

diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml
@@ -121,6 +121,9 @@
 			The node's scale. Unscaled value: [code](1, 1)[/code].
 			[b]Note:[/b] Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed.
 		</member>
+		<member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled" default="false">
+			If [code]true[/code], child nodes are sorted, otherwise sorting is disabled.
+		</member>
 		<member name="toplevel" type="bool" setter="set_as_toplevel" getter="is_set_as_toplevel" default="false">
 		</member>
 		<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
@@ -132,9 +135,6 @@
 		<member name="z_index" type="int" setter="set_z_index" getter="get_z_index" default="0">
 			Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. Must be between [constant RenderingServer.CANVAS_ITEM_Z_MIN] and [constant RenderingServer.CANVAS_ITEM_Z_MAX] (inclusive).
 		</member>
-		<member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled" default="true">
-			If [code]true[/code], child nodes are sorted, otherwise sorting is disabled.
-		</member>
 	</members>
 	<constants>
 	</constants>

diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
@@ -1200,6 +1200,8 @@
 		<constant name="VIDEO_DRIVER_GLES2" value="0" enum="VideoDriver">
 			The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web.
 		</constant>
+		<constant name="VIDEO_DRIVER_GLES3" value="1" enum="VideoDriver">
+		</constant>
 		<constant name="DAY_SUNDAY" value="0" enum="Weekday">
 			Sunday.
 		</constant>

diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
@@ -489,7 +489,7 @@
 		<member name="debug/shapes/avoidance/obstacles_static_edge_pushout_color" type="Color" setter="" getter="" default="Color( 1, 1, 0, 1 )">
 			Color of the static avoidance obstacles edges when their vertices are winded in order to push agents out, visible when "Visible Avoidance" is enabled in the Debug menu.
 		</member>
-		<member name="debug/shapes/avoidance/obstacles_static_face_pushin_color" type="Color" setter="" getter="" default="Color( 1, 0, 0, 0 )">
+		<member name="debug/shapes/avoidance/obstacles_static_face_pushin_color" type="Color" setter="" getter="" default="Color( 1, 0, 0, 0.5 )">
 			Color of the static avoidance obstacles faces when their vertices are winded in order to push agents in, visible when "Visible Avoidance" is enabled in the Debug menu.
 		</member>
 		<member name="debug/shapes/avoidance/obstacles_static_face_pushout_color" type="Color" setter="" getter="" default="Color( 1, 1, 0, 0.5 )">
@@ -1812,6 +1812,14 @@
 			The amount of UV contraction. This figure is divided by 1000000, and is a proportion of the total texture dimensions, where the width and height are both ranged from 0.0 to 1.0.
 			Use the default unless correcting for a problem on particular hardware.
 		</member>
+		<member name="rendering/cpu_lightmapper/quality/high_quality_ray_count" type="int" setter="" getter="" default="512">
+		</member>
+		<member name="rendering/cpu_lightmapper/quality/low_quality_ray_count" type="int" setter="" getter="" default="64">
+		</member>
+		<member name="rendering/cpu_lightmapper/quality/medium_quality_ray_count" type="int" setter="" getter="" default="256">
+		</member>
+		<member name="rendering/cpu_lightmapper/quality/ultra_quality_ray_count" type="int" setter="" getter="" default="1024">
+		</member>
 		<member name="rendering/environment/default_clear_color" type="Color" setter="" getter="" default="Color( 0.3, 0.3, 0.3, 1 )">
 			Default background clear color. Overridable per [Viewport] using its [Environment3D]. See [member Environment3D.background_mode] and [member Environment3D.background_color] in particular. To change this default color programmatically, use [method RenderingServer.set_default_clear_color].
 		</member>
@@ -1983,6 +1991,10 @@
 		<member name="rendering/quality/intended_usage/framebuffer_allocation.mobile" type="int" setter="" getter="" default="3">
 			Lower-end override for [member rendering/quality/intended_usage/framebuffer_allocation] on mobile devices, due to performance concerns or driver support.
 		</member>
+		<member name="rendering/quality/lightmapping/use_bicubic_sampling" type="bool" setter="" getter="" default="true">
+		</member>
+		<member name="rendering/quality/lightmapping/use_bicubic_sampling.mobile" type="bool" setter="" getter="" default="false">
+		</member>
 		<member name="rendering/quality/reflections/atlas_size" type="int" setter="" getter="" default="2048">
 			Size of the atlas used by reflection probes. A larger size can result in higher visual quality, while a smaller size will be faster and take up less memory.
 		</member>