Преглед на файлове

classref: Sync with current master branch (0cd148313)

Yuri Sizov преди 2 години
родител
ревизия
af256254cd

+ 2 - 2
classes/[email protected]

@@ -5959,7 +5959,7 @@ Returns the natural logarithm of ``x``. This is the amount of time needed to rea
 
 :ref:`Variant<class_Variant>` **max** **(** ... **)** |vararg|
 
-Returns the maximum of the given values. This function can take any number of arguments.
+Returns the maximum of the given numeric values. This function can take any number of arguments.
 
 ::
 
@@ -6009,7 +6009,7 @@ Returns the maximum of two :ref:`int<class_int>` values.
 
 :ref:`Variant<class_Variant>` **min** **(** ... **)** |vararg|
 
-Returns the minimum of the given values. This function can take any number of arguments.
+Returns the minimum of the given numeric values. This function can take any number of arguments.
 
 ::
 

+ 1 - 1
classes/class_color.rst

@@ -1753,7 +1753,7 @@ Constructs a color from an `OK HSL profile <https://bottosson.github.io/posts/co
 
 :ref:`Color<class_Color>` **from_rgbe9995** **(** :ref:`int<class_int>` rgbe **)** |static|
 
-Encodes a **Color** from a RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9995<class_Image_constant_FORMAT_RGBE9995>`.
+Decodes a **Color** from a RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9995<class_Image_constant_FORMAT_RGBE9995>`.
 
 .. rst-class:: classref-item-separator
 

+ 3 - 3
classes/class_displayserver.rst

@@ -1118,7 +1118,7 @@ enum **VSyncMode**:
 
 :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
 
-No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`). Not supported when using the Compatibility rendering method.
+No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
 
 .. _class_DisplayServer_constant_VSYNC_ENABLED:
 
@@ -1134,7 +1134,7 @@ Default vertical synchronization mode, the image is displayed only on vertical b
 
 :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
 
-Behaves like :ref:`VSYNC_DISABLED<class_DisplayServer_constant_VSYNC_DISABLED>` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`). Not supported when using the Compatibility rendering method.
+Behaves like :ref:`VSYNC_DISABLED<class_DisplayServer_constant_VSYNC_DISABLED>` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`). Behaves like :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` when using the Compatibility rendering method.
 
 .. _class_DisplayServer_constant_VSYNC_MAILBOX:
 
@@ -1144,7 +1144,7 @@ Behaves like :ref:`VSYNC_DISABLED<class_DisplayServer_constant_VSYNC_DISABLED>`
 
 Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
 
-Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag (also called "Fast" V-Sync mode). :ref:`VSYNC_MAILBOX<class_DisplayServer_constant_VSYNC_MAILBOX>` works best when at least twice as many frames as the display refresh rate are rendered. Not supported when using the Compatibility rendering method.
+Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag (also called "Fast" V-Sync mode). :ref:`VSYNC_MAILBOX<class_DisplayServer_constant_VSYNC_MAILBOX>` works best when at least twice as many frames as the display refresh rate are rendered. Behaves like :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` when using the Compatibility rendering method.
 
 .. rst-class:: classref-item-separator
 

+ 1 - 1
classes/class_expression.rst

@@ -117,7 +117,7 @@ If you defined input variables in :ref:`parse<class_Expression_method_parse>`, y
 
 :ref:`String<class_String>` **get_error_text** **(** **)** |const|
 
-Returns the error text if :ref:`parse<class_Expression_method_parse>` has failed.
+Returns the error text if :ref:`parse<class_Expression_method_parse>` or :ref:`execute<class_Expression_method_execute>` has failed.
 
 .. rst-class:: classref-item-separator
 

+ 2 - 2
classes/class_lightmapgi.rst

@@ -29,7 +29,7 @@ The **LightmapGI** node is used to compute and store baked lightmaps. Lightmaps
 
 \ **Note:** Lightmap baking on :ref:`CSGShape3D<class_CSGShape3D>`\ s and :ref:`PrimitiveMesh<class_PrimitiveMesh>`\ es is not supported, as these cannot store UV2 data required for baking.
 
-\ **Note:** If no custom lightmappers are installed, **LightmapGI** can only be baked when using the Vulkan backend (Clustered or Mobile), not OpenGL.
+\ **Note:** If no custom lightmappers are installed, **LightmapGI** can only be baked when using the Vulkan backend (Forward+ or Mobile), not OpenGL.
 
 .. rst-class:: classref-reftable-group
 
@@ -114,7 +114,7 @@ High bake quality (slow bake times). The quality of this preset can be adjusted
 
 :ref:`BakeQuality<enum_LightmapGI_BakeQuality>` **BAKE_QUALITY_ULTRA** = ``3``
 
-Highest bake quality (slowest bake times). The quality of this preset can be adjusted by changing :ref:`ProjectSettings.rendering/lightmapping/bake_quality/high_quality_ray_count<class_ProjectSettings_property_rendering/lightmapping/bake_quality/high_quality_ray_count>` and :ref:`ProjectSettings.rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count<class_ProjectSettings_property_rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count>`.
+Highest bake quality (slowest bake times). The quality of this preset can be adjusted by changing :ref:`ProjectSettings.rendering/lightmapping/bake_quality/ultra_quality_ray_count<class_ProjectSettings_property_rendering/lightmapping/bake_quality/ultra_quality_ray_count>` and :ref:`ProjectSettings.rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count<class_ProjectSettings_property_rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count>`.
 
 .. rst-class:: classref-item-separator
 

+ 1 - 1
classes/class_lightmapperrd.rst

@@ -21,7 +21,7 @@ Description
 
 LightmapperRD ("RD" stands for :ref:`RenderingDevice<class_RenderingDevice>`) is the built-in GPU-based lightmapper for use with :ref:`LightmapGI<class_LightmapGI>`. On most dedicated GPUs, it can bake lightmaps much faster than most CPU-based lightmappers. LightmapperRD uses compute shaders to bake lightmaps, so it does not require CUDA or OpenCL libraries to be installed to be usable.
 
-\ **Note:** Only usable when using the Vulkan backend (Clustered or Mobile), not OpenGL.
+\ **Note:** Only usable when using the Vulkan backend (Forward+ or Mobile), not OpenGL.
 
 .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
 .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`

+ 1 - 1
classes/class_mesh.rst

@@ -337,7 +337,7 @@ Indicates this custom channel contains half precision float colors, encoded as :
 
 :ref:`ArrayCustomFormat<enum_Mesh_ArrayCustomFormat>` **ARRAY_CUSTOM_R_FLOAT** = ``4``
 
-Indicates this custom channel contains full float colors, in a :ref:`PackedFloat32Array<class_PackedFloat32Array>`. Only the red green channel is used.
+Indicates this custom channel contains full float colors, in a :ref:`PackedFloat32Array<class_PackedFloat32Array>`. Only the red channel is used.
 
 .. _class_Mesh_constant_ARRAY_CUSTOM_RG_FLOAT:
 

+ 4 - 4
classes/class_navigationserver2d.rst

@@ -452,7 +452,7 @@ Returns the ending position of this ``link``.
 
 :ref:`float<class_float>` **link_get_enter_cost** **(** :ref:`RID<class_RID>` link **)** |const|
 
-Returns the ``enter_cost`` of this ``link``.
+Returns the enter cost of this ``link``.
 
 .. rst-class:: classref-item-separator
 
@@ -512,7 +512,7 @@ Returns the starting position of this ``link``.
 
 :ref:`float<class_float>` **link_get_travel_cost** **(** :ref:`RID<class_RID>` link **)** |const|
 
-Returns the ``travel_cost`` of this ``link``.
+Returns the travel cost of this ``link``.
 
 .. rst-class:: classref-item-separator
 
@@ -890,7 +890,7 @@ Returns how many connections this ``region`` has with other regions in the map.
 
 :ref:`float<class_float>` **region_get_enter_cost** **(** :ref:`RID<class_RID>` region **)** |const|
 
-Returns the ``enter_cost`` of this ``region``.
+Returns the enter cost of this ``region``.
 
 .. rst-class:: classref-item-separator
 
@@ -938,7 +938,7 @@ Returns the ``ObjectID`` of the object which manages this region.
 
 :ref:`float<class_float>` **region_get_travel_cost** **(** :ref:`RID<class_RID>` region **)** |const|
 
-Returns the ``travel_cost`` of this ``region``.
+Returns the travel cost of this ``region``.
 
 .. rst-class:: classref-item-separator
 

+ 4 - 4
classes/class_navigationserver3d.rst

@@ -565,7 +565,7 @@ Returns the ending position of this ``link``.
 
 :ref:`float<class_float>` **link_get_enter_cost** **(** :ref:`RID<class_RID>` link **)** |const|
 
-Returns the ``enter_cost`` of this ``link``.
+Returns the enter cost of this ``link``.
 
 .. rst-class:: classref-item-separator
 
@@ -625,7 +625,7 @@ Returns the starting position of this ``link``.
 
 :ref:`float<class_float>` **link_get_travel_cost** **(** :ref:`RID<class_RID>` link **)** |const|
 
-Returns the ``travel_cost`` of this ``link``.
+Returns the travel cost of this ``link``.
 
 .. rst-class:: classref-item-separator
 
@@ -1063,7 +1063,7 @@ Returns how many connections this ``region`` has with other regions in the map.
 
 :ref:`float<class_float>` **region_get_enter_cost** **(** :ref:`RID<class_RID>` region **)** |const|
 
-Returns the ``enter_cost`` of this ``region``.
+Returns the enter cost of this ``region``.
 
 .. rst-class:: classref-item-separator
 
@@ -1111,7 +1111,7 @@ Returns the ``ObjectID`` of the object which manages this region.
 
 :ref:`float<class_float>` **region_get_travel_cost** **(** :ref:`RID<class_RID>` region **)** |const|
 
-Returns the ``travel_cost`` of this ``region``.
+Returns the travel cost of this ``region``.
 
 .. rst-class:: classref-item-separator
 

+ 4 - 2
classes/class_projectsettings.rst

@@ -8833,9 +8833,11 @@ Enables the use of physically based units for light sources. Physically based un
 
 :ref:`float<class_float>` **rendering/limits/cluster_builder/max_clustered_elements** = ``512``
 
-.. container:: contribute
+The maximum number of clustered elements (:ref:`OmniLight3D<class_OmniLight3D>` + :ref:`SpotLight3D<class_SpotLight3D>` + :ref:`Decal<class_Decal>` + :ref:`ReflectionProbe<class_ReflectionProbe>`) that can be rendered at once in the camera view. If there are more clustered elements present in the camera view, some of them will not be rendered (leading to pop-in during camera movement). Enabling distance fade on lights and decals (:ref:`Light3D.distance_fade_enabled<class_Light3D_property_distance_fade_enabled>`, :ref:`Decal.distance_fade_enabled<class_Decal_property_distance_fade_enabled>`) can help avoid reaching this limit.
 
-	There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
+Decreasing this value may improve GPU performance on certain setups, even if the maximum number of clustered elements is never reached in the project.
+
+\ **Note:** This setting is only effective when using the Forward+ rendering method, not Mobile and Compatibility.
 
 .. rst-class:: classref-item-separator
 

+ 1 - 1
classes/class_reflectionprobe.rst

@@ -34,7 +34,7 @@ The **ReflectionProbe** is used to create high-quality reflections at a low perf
 Tutorials
 ---------
 
-- :doc:`Reflection probes <../tutorials/3d/reflection_probes>`
+- :doc:`Reflection probes <../tutorials/3d/global_illumination/reflection_probes>`
 
 .. rst-class:: classref-reftable-group
 

+ 4 - 4
classes/class_shapecast3d.rst

@@ -68,7 +68,7 @@ Methods
    :widths: auto
 
    +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | void                          | :ref:`add_exception<class_ShapeCast3D_method_add_exception>` **(** :ref:`Object<class_Object>` node **)**                                                        |
+   | void                          | :ref:`add_exception<class_ShapeCast3D_method_add_exception>` **(** :ref:`CollisionObject3D<class_CollisionObject3D>` node **)**                                  |
    +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | void                          | :ref:`add_exception_rid<class_ShapeCast3D_method_add_exception_rid>` **(** :ref:`RID<class_RID>` rid **)**                                                       |
    +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -96,7 +96,7 @@ Methods
    +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | :ref:`bool<class_bool>`       | :ref:`is_colliding<class_ShapeCast3D_method_is_colliding>` **(** **)** |const|                                                                                   |
    +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | void                          | :ref:`remove_exception<class_ShapeCast3D_method_remove_exception>` **(** :ref:`Object<class_Object>` node **)**                                                  |
+   | void                          | :ref:`remove_exception<class_ShapeCast3D_method_remove_exception>` **(** :ref:`CollisionObject3D<class_CollisionObject3D>` node **)**                            |
    +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | void                          | :ref:`remove_exception_rid<class_ShapeCast3D_method_remove_exception_rid>` **(** :ref:`RID<class_RID>` rid **)**                                                 |
    +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -307,7 +307,7 @@ Method Descriptions
 
 .. rst-class:: classref-method
 
-void **add_exception** **(** :ref:`Object<class_Object>` node **)**
+void **add_exception** **(** :ref:`CollisionObject3D<class_CollisionObject3D>` node **)**
 
 Adds a collision exception so the shape does not report collisions with the specified :ref:`CollisionObject3D<class_CollisionObject3D>` node.
 
@@ -479,7 +479,7 @@ Returns whether any object is intersecting with the shape's vector (considering
 
 .. rst-class:: classref-method
 
-void **remove_exception** **(** :ref:`Object<class_Object>` node **)**
+void **remove_exception** **(** :ref:`CollisionObject3D<class_CollisionObject3D>` node **)**
 
 Removes a collision exception so the shape does report collisions with the specified :ref:`CollisionObject3D<class_CollisionObject3D>` node.
 

+ 1 - 1
classes/class_tileset.rst

@@ -1114,7 +1114,7 @@ Returns the number of terrains in the given terrain set.
 
 :ref:`bool<class_bool>` **has_alternative_level_tile_proxy** **(** :ref:`int<class_int>` source_from, :ref:`Vector2i<class_Vector2i>` coords_from, :ref:`int<class_int>` alternative_from **)**
 
-Returns if there is and alternative-level proxy for the given identifiers.
+Returns if there is an alternative-level proxy for the given identifiers.
 
 .. rst-class:: classref-item-separator
 

+ 1 - 1
classes/class_visualinstance3d.rst

@@ -104,7 +104,7 @@ For :ref:`Light3D<class_Light3D>`\ s, this can be used to control which **Visual
 - void **set_sorting_offset** **(** :ref:`float<class_float>` value **)**
 - :ref:`float<class_float>` **get_sorting_offset** **(** **)**
 
-The sorting offset used by this **VisualInstance3D**. Adjusting it to a higher value will make the **VisualInstance3D** reliably draw on top of other **VisualInstance3D**\ s that are otherwise positioned at the same spot.
+The amount by which the depth of this **VisualInstance3D** will be adjusted when sorting by depth. Uses the same units as the engine (which are typically meters). Adjusting it to a higher value will make the **VisualInstance3D** reliably draw on top of other **VisualInstance3D**\ s that are otherwise positioned at the same spot. To ensure it always draws on top of other objects around it (not positioned at the same spot), set the value to be greater than the distance between this **VisualInstance3D** and the other nearby **VisualInstance3D**\ s.
 
 .. rst-class:: classref-item-separator
 

+ 1 - 1
classes/class_visualshadernodederivativefunc.rst

@@ -230,7 +230,7 @@ A type of operands and returned value. See :ref:`OpType<enum_VisualShaderNodeDer
 - void **set_precision** **(** :ref:`Precision<enum_VisualShaderNodeDerivativeFunc_Precision>` value **)**
 - :ref:`Precision<enum_VisualShaderNodeDerivativeFunc_Precision>` **get_precision** **(** **)**
 
-Sets the level of precision to use for the derivative function. See :ref:`Precision<enum_VisualShaderNodeDerivativeFunc_Precision>` for options. When using the GL_Compatibility renderer, this setting has no effect.
+Sets the level of precision to use for the derivative function. See :ref:`Precision<enum_VisualShaderNodeDerivativeFunc_Precision>` for options. When using the GL Compatibility renderer, this setting has no effect.
 
 .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
 .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`

+ 1 - 1
classes/class_voxelgi.rst

@@ -34,7 +34,7 @@ Description
 Tutorials
 ---------
 
-- :doc:`VoxelGI <../tutorials/3d/using_voxel_gi>`
+- :doc:`VoxelGI <../tutorials/3d/global_illumination/using_voxel_gi>`
 
 - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__