|
@@ -1453,19 +1453,19 @@ Properties
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`rendering/environment/volumetric_fog/volume_size<class_ProjectSettings_property_rendering/environment/volumetric_fog/volume_size>` | ``64`` |
|
|
| :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>` | |
|
|
|
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.android<class_ProjectSettings_property_rendering/gl_compatibility/driver.android>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.ios<class_ProjectSettings_property_rendering/gl_compatibility/driver.ios>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.linuxbsd<class_ProjectSettings_property_rendering/gl_compatibility/driver.linuxbsd>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.macos<class_ProjectSettings_property_rendering/gl_compatibility/driver.macos>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.web<class_ProjectSettings_property_rendering/gl_compatibility/driver.web>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.windows<class_ProjectSettings_property_rendering/gl_compatibility/driver.windows>` | |
|
|
|
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/gl_compatibility/driver.windows<class_ProjectSettings_property_rendering/gl_compatibility/driver.windows>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :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_angle<class_ProjectSettings_property_rendering/gl_compatibility/fallback_to_angle>` | ``true`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
@@ -1611,17 +1611,17 @@ Properties
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame<class_ProjectSettings_property_rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame>` | ``1024`` |
|
|
| :ref:`int<class_int>` | :ref:`rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame<class_ProjectSettings_property_rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame>` | ``1024`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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<class_ProjectSettings_property_rendering/rendering_device/driver>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.android<class_ProjectSettings_property_rendering/rendering_device/driver.android>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.ios<class_ProjectSettings_property_rendering/rendering_device/driver.ios>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.linuxbsd<class_ProjectSettings_property_rendering/rendering_device/driver.linuxbsd>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :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.macos<class_ProjectSettings_property_rendering/rendering_device/driver.macos>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
- | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.windows<class_ProjectSettings_property_rendering/rendering_device/driver.windows>` | |
|
|
|
|
|
|
+ | :ref:`String<class_String>` | :ref:`rendering/rendering_device/driver.windows<class_ProjectSettings_property_rendering/rendering_device/driver.windows>` | ``"auto"`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`rendering/rendering_device/fallback_to_d3d12<class_ProjectSettings_property_rendering/rendering_device/fallback_to_d3d12>` | ``true`` |
|
|
| :ref:`bool<class_bool>` | :ref:`rendering/rendering_device/fallback_to_d3d12<class_ProjectSettings_property_rendering/rendering_device/fallback_to_d3d12>` | ``true`` |
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
@@ -9344,6 +9344,8 @@ If ``true``, enable TLSv1.3 negotiation.
|
|
|
|
|
|
\ **Note:** This is experimental, and may cause connections to fail in some cases (notably, if the remote server uses TLS handshake fragmentation).
|
|
\ **Note:** This is experimental, and may cause connections to fail in some cases (notably, if the remote server uses TLS handshake fragmentation).
|
|
|
|
|
|
|
|
+\ **Note:** Only supported when using Mbed TLS 3.0 or later (Linux distribution packages may be compiled against older system Mbed TLS packages), otherwise the maximum supported TLS version is always TLSv1.2.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -10950,10 +10952,22 @@ Base size used to determine size of froxel buffer in the camera X-axis and Y-axi
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver** :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_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.
|
|
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.
|
|
|
|
|
|
|
|
+Supported values are:
|
|
|
|
+
|
|
|
|
+- ``auto``, currently defaults to ``opengl3`` on all platforms.
|
|
|
|
+
|
|
|
|
+- ``opengl3``, OpenGL 3.3 on desktop platforms, OpenGL ES 3.0 on mobile platforms, WebGL 2.0 on web.
|
|
|
|
+
|
|
|
|
+- ``opengl3_angle``, OpenGL ES 3.0 over ANGLE compatibility layer, supported on macOS (over native OpenGL) and Windows (over Direct3D 11).
|
|
|
|
+
|
|
|
|
+- ``opengl3_es``, OpenGL ES 3.0 on Linux/BSD.
|
|
|
|
+
|
|
|
|
+\ **Note:** The availability of these options depends on whether the engine was compiled with support for them (determined by SCons options ``opengl3`` and ``angle_libs``).
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -10962,10 +10976,12 @@ Sets the driver to be used by the renderer when using the Compatibility renderer
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.android** :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.android>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.android** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.android>`
|
|
|
|
|
|
Android override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
Android override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``opengl3`` on this platform.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -10974,10 +10990,12 @@ Android override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettin
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.ios** :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.ios>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.ios** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.ios>`
|
|
|
|
|
|
iOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
iOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``opengl3`` on this platform.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -10986,10 +11004,12 @@ iOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_p
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.linuxbsd** :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.linuxbsd>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.linuxbsd** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.linuxbsd>`
|
|
|
|
|
|
LinuxBSD override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
LinuxBSD override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``opengl3`` on this platform. ``opengl3_es`` is available as an option, which is also used as a fallback on devices that don't support OpenGL 3.3.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -10998,10 +11018,12 @@ LinuxBSD override for :ref:`rendering/gl_compatibility/driver<class_ProjectSetti
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.macos** :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.macos>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.macos** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.macos>`
|
|
|
|
|
|
macOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
macOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``opengl3`` on this platform. ``opengl3_angle`` is available as an option if ANGLE support was compiled in.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -11010,10 +11032,12 @@ macOS override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.web** :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.web>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.web** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.web>`
|
|
|
|
|
|
Web override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
Web override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``opengl3`` on this platform.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -11022,10 +11046,12 @@ Web override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_p
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/gl_compatibility/driver.windows** :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.windows>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/gl_compatibility/driver.windows** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/gl_compatibility/driver.windows>`
|
|
|
|
|
|
Windows override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
Windows override for :ref:`rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``opengl3`` on this platform. ``opengl3_angle`` is available as an option if ANGLE supported was compiled in. In such case, ANGLE is used preferentially on lower end devices with known problematic native OpenGL drivers (see :ref:`rendering/gl_compatibility/force_angle_on_devices<class_ProjectSettings_property_rendering/gl_compatibility/force_angle_on_devices>`).
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -11998,10 +12024,22 @@ Depending on the complexity of scenes, this value may be lowered or may need to
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver** :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver>`
|
|
|
|
|
|
Sets the driver to be used by the renderer when using a RenderingDevice-based renderer like the Forward+ or Mobile renderers. This property can't be edited directly. Instead, set the driver using the platform-specific overrides. This can be overridden using the ``--rendering-driver <driver>`` command line argument.
|
|
Sets the driver to be used by the renderer when using a RenderingDevice-based renderer like the Forward+ or Mobile renderers. This property can't be edited directly. Instead, set the driver using the platform-specific overrides. This can be overridden using the ``--rendering-driver <driver>`` command line argument.
|
|
|
|
|
|
|
|
+Supported values are:
|
|
|
|
+
|
|
|
|
+- ``auto``, Metal on Apple Silicon Macs and iOS, Vulkan on other built-in platforms. On Windows, Direct3D 12 is the default if the engine was compiled without Vulkan support.
|
|
|
|
+
|
|
|
|
+- ``metal``, Metal (supported on Apple Silicon Macs and iOS).
|
|
|
|
+
|
|
|
|
+- ``vulkan``, Vulkan (supported on all desktop and mobile platforms).
|
|
|
|
+
|
|
|
|
+- ``d3d12``, Direct3D 12 (supported on Windows).
|
|
|
|
+
|
|
|
|
+\ **Note:** The availability of these options depends on whether the engine was compiled with support for them (determined by SCons options ``vulkan``, ``metal``, and ``d3d12``).
|
|
|
|
+
|
|
\ **Note:** The actual rendering driver may be automatically changed by the engine as a result of a fallback, or a user-specified command line argument. To get the actual rendering driver that is used at runtime, use :ref:`RenderingServer.get_current_rendering_driver_name()<class_RenderingServer_method_get_current_rendering_driver_name>` instead of reading this project setting's value.
|
|
\ **Note:** The actual rendering driver may be automatically changed by the engine as a result of a fallback, or a user-specified command line argument. To get the actual rendering driver that is used at runtime, use :ref:`RenderingServer.get_current_rendering_driver_name()<class_RenderingServer_method_get_current_rendering_driver_name>` instead of reading this project setting's value.
|
|
|
|
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
@@ -12012,10 +12050,14 @@ Sets the driver to be used by the renderer when using a RenderingDevice-based re
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.android** :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.android>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.android** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.android>`
|
|
|
|
|
|
Android override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
Android override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``vulkan`` on this platform.
|
|
|
|
+
|
|
|
|
+\ **Note:** If Vulkan was disabled at compile time, there is no alternative RenderingDevice driver.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -12024,10 +12066,14 @@ Android override for :ref:`rendering/rendering_device/driver<class_ProjectSettin
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.ios** :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.ios>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.ios** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.ios>`
|
|
|
|
|
|
iOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
iOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``metal`` on this platform.
|
|
|
|
+
|
|
|
|
+\ **Note:** If Metal was disabled at compile time, the default becomes ``vulkan``. If both Metal and Vulkan were disabled at compile time, there is no alternative RenderingDevice driver.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -12036,10 +12082,14 @@ iOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_p
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.linuxbsd** :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.linuxbsd>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.linuxbsd** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.linuxbsd>`
|
|
|
|
|
|
LinuxBSD override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
LinuxBSD override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``vulkan`` on this platform.
|
|
|
|
+
|
|
|
|
+\ **Note:** If Vulkan was disabled at compile time, there is no alternative RenderingDevice driver.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -12048,10 +12098,14 @@ LinuxBSD override for :ref:`rendering/rendering_device/driver<class_ProjectSetti
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.macos** :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.macos>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.macos** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.macos>`
|
|
|
|
|
|
macOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
macOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``metal`` on Apple Silicon Macs, and ``vulkan`` (MoltenVK) on Intel Macs. Metal isn't supported on Intel Macs, so even if setting ``metal`` explicitly, it will fallback to Vulkan on Intel Macs.
|
|
|
|
+
|
|
|
|
+\ **Note:** If Metal was disabled at compile time, the default becomes ``vulkan`` for both Apple Silicon and Intel Macs. If both Metal and Vulkan were disabled at compile time, there is no alternative RenderingDevice driver.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|
|
@@ -12060,10 +12114,14 @@ macOS override for :ref:`rendering/rendering_device/driver<class_ProjectSettings
|
|
|
|
|
|
.. rst-class:: classref-property
|
|
.. rst-class:: classref-property
|
|
|
|
|
|
-:ref:`String<class_String>` **rendering/rendering_device/driver.windows** :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.windows>`
|
|
|
|
|
|
+:ref:`String<class_String>` **rendering/rendering_device/driver.windows** = ``"auto"`` :ref:`🔗<class_ProjectSettings_property_rendering/rendering_device/driver.windows>`
|
|
|
|
|
|
Windows override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
Windows override for :ref:`rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
|
|
|
|
|
|
|
|
+The ``auto`` setting is equivalent to ``vulkan`` on this platform.
|
|
|
|
+
|
|
|
|
+\ **Note:** If Vulkan was disabled at compile time, the default becomes ``d3d12``. If both Vulkan and Direct3D 12 were disabled at compile time, there is no alternative RenderingDevice driver.
|
|
|
|
+
|
|
.. rst-class:: classref-item-separator
|
|
.. rst-class:: classref-item-separator
|
|
|
|
|
|
----
|
|
----
|