|
@@ -1309,22 +1309,24 @@ Properties
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
| :ref:`int<class_int>` | :ref:`rendering/environment/volumetric_fog/volume_size<class_ProjectSettings_property_rendering/environment/volumetric_fog/volume_size>` | ``64`` |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>` | ``"opengl3"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.android<class_ProjectSettings_property_rendering/gl_compatibility/driver.android>` | ``"opengl3"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.android<class_ProjectSettings_property_rendering/gl_compatibility/driver.android>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.ios<class_ProjectSettings_property_rendering/gl_compatibility/driver.ios>` | ``"opengl3"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.ios<class_ProjectSettings_property_rendering/gl_compatibility/driver.ios>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.linuxbsd<class_ProjectSettings_property_rendering/gl_compatibility/driver.linuxbsd>` | ``"opengl3"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.linuxbsd<class_ProjectSettings_property_rendering/gl_compatibility/driver.linuxbsd>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.macos<class_ProjectSettings_property_rendering/gl_compatibility/driver.macos>` | ``"opengl3"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.macos<class_ProjectSettings_property_rendering/gl_compatibility/driver.macos>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.web<class_ProjectSettings_property_rendering/gl_compatibility/driver.web>` | ``"opengl3"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.web<class_ProjectSettings_property_rendering/gl_compatibility/driver.web>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.windows<class_ProjectSettings_property_rendering/gl_compatibility/driver.windows>` | ``"opengl3"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.windows<class_ProjectSettings_property_rendering/gl_compatibility/driver.windows>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
| :ref:`bool<class_bool>` | :ref:`rendering/gl_compatibility/fallback_to_angle<class_ProjectSettings_property_rendering/gl_compatibility/fallback_to_angle>` | ``true`` |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`bool<class_bool>` | :ref:`rendering/gl_compatibility/fallback_to_native<class_ProjectSettings_property_rendering/gl_compatibility/fallback_to_native>` | ``true`` |
|
|
|
+ +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
| :ref:`Array<class_Array>` | :ref:`rendering/gl_compatibility/force_angle_on_devices<class_ProjectSettings_property_rendering/gl_compatibility/force_angle_on_devices>` | ``[]`` |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
| :ref:`int<class_int>` | :ref:`rendering/gl_compatibility/item_buffer_size<class_ProjectSettings_property_rendering/gl_compatibility/item_buffer_size>` | ``16384`` |
|
|
@@ -1449,17 +1451,17 @@ Properties
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
| :ref:`String<class_String>` | :ref:`rendering/renderer/rendering_method.web<class_ProjectSettings_property_rendering/renderer/rendering_method.web>` | ``"gl_compatibility"`` |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>` | ``"vulkan"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.android<class_ProjectSettings_property_rendering/rendering_device/driver.android>` | ``"vulkan"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.android<class_ProjectSettings_property_rendering/rendering_device/driver.android>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.ios<class_ProjectSettings_property_rendering/rendering_device/driver.ios>` | ``"vulkan"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.ios<class_ProjectSettings_property_rendering/rendering_device/driver.ios>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.linuxbsd<class_ProjectSettings_property_rendering/rendering_device/driver.linuxbsd>` | ``"vulkan"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.linuxbsd<class_ProjectSettings_property_rendering/rendering_device/driver.linuxbsd>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.macos<class_ProjectSettings_property_rendering/rendering_device/driver.macos>` | ``"vulkan"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.macos<class_ProjectSettings_property_rendering/rendering_device/driver.macos>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.windows<class_ProjectSettings_property_rendering/rendering_device/driver.windows>` | ``"vulkan"`` |
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.windows<class_ProjectSettings_property_rendering/rendering_device/driver.windows>` | |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
| :ref:`float<class_float>` | :ref:`rendering/rendering_device/pipeline_cache/save_chunk_size_mb<class_ProjectSettings_property_rendering/rendering_device/pipeline_cache/save_chunk_size_mb>` | ``3.0`` |
|
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
@@ -2886,6 +2888,8 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w
|
|
|
|
|
|
When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable or parameter has no static type, or if a function has no static return type.
|
|
|
|
|
|
+\ **Note:** This warning is recommended together with :ref:`EditorSettings.text_editor/completion/add_type_hints<class_EditorSettings_property_text_editor/completion/add_type_hints>` to help achieve type safety.
|
|
|
+
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
@@ -3896,7 +3900,7 @@ On desktop platforms, overrides the game's initial window height. See also :ref:
|
|
|
|
|
|
On desktop platforms, overrides the game's initial window width. See also :ref:`display/window/size/window_height_override<class_ProjectSettings_property_display/window/size/window_height_override>`, :ref:`display/window/size/viewport_width<class_ProjectSettings_property_display/window/size/viewport_width>` and :ref:`display/window/size/viewport_height<class_ProjectSettings_property_display/window/size/viewport_height>`.
|
|
|
|
|
|
-\ **Note:** By default, or when set to ``0``, the initial window width is the viewport :ref:`display/window/size/viewport_width<class_ProjectSettings_property_display/window/size/viewport_width>`. This setting is ignored on iOS, Android, and Web.
|
|
|
+\ **Note:** By default, or when set to ``0``, the initial window width is the :ref:`display/window/size/viewport_width<class_ProjectSettings_property_display/window/size/viewport_width>`. This setting is ignored on iOS, Android, and Web.
|
|
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
@@ -3954,6 +3958,12 @@ The scale factor multiplier to use for 2D elements. This multiplies the final sc
|
|
|
|
|
|
The policy to use to determine the final scale factor for 2D elements. This affects how :ref:`display/window/stretch/scale<class_ProjectSettings_property_display/window/stretch/scale>` is applied, in addition to the automatic scale factor determined by :ref:`display/window/stretch/mode<class_ProjectSettings_property_display/window/stretch/mode>`.
|
|
|
|
|
|
+\ **"fractional"**: The scale factor will not be modified.
|
|
|
+
|
|
|
+\ **"integer"**: The scale factor will be floored to an integer value, which means that the screen size will always be an integer multiple of the base viewport size. This provides a crisp pixel art appearance.
|
|
|
+
|
|
|
+\ **Note:** When using integer scaling with a stretch mode, resizing the window to be smaller than the base viewport size will clip the contents. Consider preventing that by setting :ref:`Window.min_size<class_Window_property_min_size>` to the same value as the base viewport size defined in :ref:`display/window/size/viewport_width<class_ProjectSettings_property_display/window/size/viewport_width>` and :ref:`display/window/size/viewport_height<class_ProjectSettings_property_display/window/size/viewport_height>`.
|
|
|
+
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
@@ -9672,7 +9682,7 @@ Base size used to determine size of froxel buffer in the camera X-axis and Y-axi
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver** = ``"opengl3"``
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver**
|
|
|
|
|
|
Sets the driver to be used by the renderer when using the Compatibility renderer. This property can not be edited directly, instead, set the driver using the platform-specific overrides.
|
|
|
|
|
@@ -9684,7 +9694,7 @@ Sets the driver to be used by the renderer when using the Compatibility renderer
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.android** = ``"opengl3"``
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.android**
|
|
|
|
|
|
Android override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
@@ -9696,7 +9706,7 @@ Android override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettin
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.ios** = ``"opengl3"``
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.ios**
|
|
|
|
|
|
iOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
@@ -9708,7 +9718,7 @@ iOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_p
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.linuxbsd** = ``"opengl3"``
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.linuxbsd**
|
|
|
|
|
|
LinuxBSD override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
@@ -9720,7 +9730,7 @@ LinuxBSD override for :ref:`rendering/gl_compatibility/driver<class_ProjectSetti
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.macos** = ``"opengl3"``
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.macos**
|
|
|
|
|
|
macOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
@@ -9732,7 +9742,7 @@ macOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.web** = ``"opengl3"``
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.web**
|
|
|
|
|
|
Web override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
@@ -9744,7 +9754,7 @@ Web override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_p
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.windows** = ``"opengl3"``
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.windows**
|
|
|
|
|
|
Windows override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
@@ -9760,6 +9770,22 @@ Windows override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettin
|
|
|
|
|
|
If ``true``, the compatibility renderer will fall back to ANGLE if native OpenGL is not supported or the device is listed in :ref:`rendering/gl_compatibility/force_angle_on_devices<class_ProjectSettings_property_rendering/gl_compatibility/force_angle_on_devices>`.
|
|
|
|
|
|
+\ **Note:** This setting is implemented only on Windows.
|
|
|
+
|
|
|
+.. rst-class:: classref-item-separator
|
|
|
+
|
|
|
+----
|
|
|
+
|
|
|
+.. _class_ProjectSettings_property_rendering/gl_compatibility/fallback_to_native:
|
|
|
+
|
|
|
+.. rst-class:: classref-property
|
|
|
+
|
|
|
+:ref:`bool<class_bool>` **rendering/gl_compatibility/fallback_to_native** = ``true``
|
|
|
+
|
|
|
+If ``true``, the compatibility renderer will fall back to native OpenGL if ANGLE over Metal is not supported.
|
|
|
+
|
|
|
+\ **Note:** This setting is implemented only on macOS.
|
|
|
+
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
@@ -9774,6 +9800,8 @@ An :ref:`Array<class_Array>` of devices which should always use the ANGLE render
|
|
|
|
|
|
Each entry is a :ref:`Dictionary<class_Dictionary>` with the following keys: ``vendor`` and ``name``. ``name`` can be set to ``*`` to add all devices with the specified ``vendor``.
|
|
|
|
|
|
+\ **Note:** This setting is implemented only on Windows.
|
|
|
+
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
@@ -10586,7 +10614,7 @@ Override for :ref:`rendering/renderer/rendering_method<class_ProjectSettings_pro
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver** = ``"vulkan"``
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver**
|
|
|
|
|
|
Sets the driver to be used by the renderer when using a RenderingDevice-based renderer like the clustered renderer or the mobile renderer. This property can not be edited directly, instead, set the driver using the platform-specific overrides.
|
|
|
|
|
@@ -10598,7 +10626,7 @@ Sets the driver to be used by the renderer when using a RenderingDevice-based re
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.android** = ``"vulkan"``
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.android**
|
|
|
|
|
|
Android override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
@@ -10610,7 +10638,7 @@ Android override for :ref:`rendering/rendering_device/driver<class_ProjectSettin
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.ios** = ``"vulkan"``
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.ios**
|
|
|
|
|
|
iOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
@@ -10622,7 +10650,7 @@ iOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_p
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.linuxbsd** = ``"vulkan"``
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.linuxbsd**
|
|
|
|
|
|
LinuxBSD override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
@@ -10634,7 +10662,7 @@ LinuxBSD override for :ref:`rendering/rendering_device/driver<class_ProjectSetti
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.macos** = ``"vulkan"``
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.macos**
|
|
|
|
|
|
macOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
@@ -10646,7 +10674,7 @@ macOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.windows** = ``"vulkan"``
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.windows**
|
|
|
|
|
|
Windows override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|