diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 94c975b468e..a8eb4a8da9d 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -2684,26 +2684,48 @@ Base size used to determine size of froxel buffer in the camera X-axis and Y-axis. The final size is scaled by the aspect ratio of the screen, so actual values may differ from what is set. Set a larger size for more detailed fog, set a smaller size for better performance. - - 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. Editing this property has no effect in the default configuration, as first-party platforms each have platform-specific overrides. Use those overrides to configure the driver for each platform. + This can be overridden using the [code]--rendering-driver <driver>[/code] command line argument. + Supported values are: + - [code]opengl3[/code], OpenGL 3.3 on desktop platforms, OpenGL ES 3.0 on mobile platforms, WebGL 2.0 on web. + - [code]opengl3_angle[/code], OpenGL ES 3.0 using the ANGLE compatibility layer, supported on macOS (over native OpenGL) and Windows (over Direct3D 11). + - [code]opengl3_es[/code], OpenGL ES 3.0 on Linux/BSD. + [b]Note:[/b] The availability of these options depends on whether the engine was compiled with support for them (determined by SCons options [code]opengl3[/code] and [code]angle_libs[/code]). + [b]Note:[/b] 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 [method RenderingServer.get_current_rendering_driver_name] instead of reading this project setting's value. - + Android override for [member rendering/gl_compatibility/driver]. + Only one option is supported: + - [code]opengl3[/code], OpenGL ES 3.0 from native drivers. - + iOS override for [member rendering/gl_compatibility/driver]. + Only one option is supported: + - [code]opengl3[/code], OpenGL ES 3.0 from native drivers. - + LinuxBSD override for [member rendering/gl_compatibility/driver]. + Two options are supported: + - [code]opengl3[/code] (default), OpenGL 3.3 from native drivers. + - [code]opengl3_es[/code], OpenGL ES 3.0 from native drivers. If [member rendering/gl_compatibility/fallback_to_gles] is enabled, this is used as a fallback if OpenGL 3.3 is not supported. - + macOS override for [member rendering/gl_compatibility/driver]. + Two options are supported: + - [code]opengl3[/code] (default), OpenGL 3.3 from native drivers. If [member rendering/gl_compatibility/fallback_to_native] is enabled, this is used as a fallback if ANGLE is configured as the preferred driver but not supported. + - [code]opengl3_angle[/code], OpenGL ES 3.0 using the ANGLE compatibility layer over native OpenGL drivers. If [member rendering/gl_compatibility/fallback_to_angle] is enabled, this is used as a fallback if OpenGL 3.3 is not supported. - + Web override for [member rendering/gl_compatibility/driver]. + Only one option is supported: + - [code]opengl3[/code], WebGL 2.0. The underlying native API depends on the target OS, browser, and browser configuration. - + Windows override for [member rendering/gl_compatibility/driver]. + Two options are supported: + - [code]opengl3[/code] (default), OpenGL 3.3 from native drivers. If [member rendering/gl_compatibility/fallback_to_native] is enabled, this is used as a fallback if ANGLE is configured as the preferred driver but not supported. + - [code]opengl3_angle[/code], OpenGL ES 3.0 using the ANGLE compatibility layer over native Direct3D 11 drivers. If [member rendering/gl_compatibility/fallback_to_angle] is enabled, this is used as a fallback if OpenGL 3.3 is not supported. By default, ANGLE is used as the default driver for some devices listed in [member rendering/gl_compatibility/force_angle_on_devices]. If [code]true[/code], the compatibility renderer will fall back to ANGLE if native OpenGL is not supported or the device is listed in [member rendering/gl_compatibility/force_angle_on_devices]. @@ -2969,27 +2991,49 @@ The number of entries in the sampler descriptors heap the Direct3D 12 rendering driver uses each frame, used for most rendering operations. Depending on the complexity of scenes, this value may be lowered or may need to be raised. - - 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 [code]--rendering-driver <driver>[/code] command line argument. + + Sets the driver to be used by the renderer when using a RenderingDevice-based renderer like the Forward+ or Mobile renderers. Editing this property has no effect in the default configuration, as first-party platforms each have platform-specific overrides. Use those overrides to configure the driver for each platform. + This can be overridden using the [code]--rendering-driver <driver>[/code] command line argument. + Supported values are: + - [code]metal[/code], Metal (supported on Apple Silicon Macs and iOS). + - [code]vulkan[/code], Vulkan (supported on all desktop and mobile platforms). + - [code]d3d12[/code], Direct3D 12 (supported on Windows). + [b]Note:[/b] The availability of these options depends on whether the engine was compiled with support for them (determined by SCons options [code]vulkan[/code], [code]metal[/code], and [code]d3d12[/code]). + [b]Note:[/b] If a given platform has no registered drivers, it can fall back to the Compatibility renderer (OpenGL 3) if [member rendering/rendering_device/fallback_to_opengl3] is enabled. This fallback happens automatically for the Web platform regardless of that property. [b]Note:[/b] 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 [method RenderingServer.get_current_rendering_driver_name] instead of reading this project setting's value. - + Android override for [member rendering/rendering_device/driver]. + Only one option is supported: + - [code]vulkan[/code], Vulkan from native drivers. + [b]Note:[/b] If Vulkan was disabled at compile time, there is no alternative RenderingDevice driver. - + iOS override for [member rendering/rendering_device/driver]. + Two options are supported: + - [code]metal[/code] (default), Metal from native drivers. + - [code]vulkan[/code], Vulkan over Metal via MoltenVK. - + LinuxBSD override for [member rendering/rendering_device/driver]. + Only one option is supported: + - [code]vulkan[/code], Vulkan from native drivers. + [b]Note:[/b] If Vulkan was disabled at compile time, there is no alternative RenderingDevice driver. - + macOS override for [member rendering/rendering_device/driver]. + Two options are supported: + - [code]metal[/code] (default), Metal from native drivers, only supported on Apple Silicon Macs. On Intel Macs, it will automatically fall back to [code]vulkan[/code] as Metal support is not implemented. + - [code]vulkan[/code], Vulkan over Metal via MoltenVK, supported on both Apple Silicon and Intel Macs. - + Windows override for [member rendering/rendering_device/driver]. + Two options are supported: + - [code]vulkan[/code] (default), Vulkan from native drivers. If [member rendering/rendering_device/fallback_to_vulkan] is enabled, this is used as a fallback if Direct3D 12 is not supported. + - [code]d3d12[/code], Direct3D 12 from native drivers. If [member rendering/rendering_device/fallback_to_d3d12] is enabled, this is used as a fallback if Vulkan is not supported. - If [code]true[/code], the forward renderer will fall back to Direct3D 12 if Vulkan is not supported. + If [code]true[/code], the forward renderer will fall back to Direct3D 12 if Vulkan is not supported. The fallback is always attempted regardless of this setting if Vulkan driver support was disabled at compile time. [b]Note:[/b] This setting is implemented only on Windows. @@ -2997,7 +3041,7 @@ [b]Note:[/b] This setting is implemented only on Windows, Android, macOS, iOS, and Linux/X11. - If [code]true[/code], the forward renderer will fall back to Vulkan if Direct3D 12 (on Windows) or Metal (on macOS x86_64) are not supported. + If [code]true[/code], the forward renderer will fall back to Vulkan if Direct3D 12 (on Windows) or Metal (on macOS x86_64) are not supported. The fallback is always attempted regardless of this setting if Direct3D 12 (Windows) or Metal (macOS) driver support was disabled at compile time. [b]Note:[/b] This setting is implemented only on Windows and macOS. diff --git a/main/main.cpp b/main/main.cpp index 40b9fc8cd9a..6fbe3867622 100644 --- a/main/main.cpp +++ b/main/main.cpp @@ -2030,41 +2030,20 @@ Error Main::setup(const char *execpath, int argc, char *argv[], bool p_second_ph Logger::set_flush_stdout_on_print(GLOBAL_GET("application/run/flush_stdout_on_print")); + // Rendering drivers configuration. + + // Always include all supported drivers as hint, as this is used by the editor host platform + // for project settings. For example, a Linux user should be able to configure that they want + // to export for D3D12 on Windows and Metal on macOS even if their host platform can't use those. + { - String driver_hints = ""; - String driver_hints_with_d3d12 = ""; - String driver_hints_with_metal = ""; - - { - Vector driver_hints_arr; -#ifdef VULKAN_ENABLED - driver_hints_arr.push_back("vulkan"); -#endif - driver_hints = String(",").join(driver_hints_arr); - -#ifdef D3D12_ENABLED - driver_hints_arr.push_back("d3d12"); -#endif - driver_hints_with_d3d12 = String(",").join(driver_hints_arr); - -#ifdef METAL_ENABLED - // Make metal the preferred and default driver. - driver_hints_arr.insert(0, "metal"); -#endif - driver_hints_with_metal = String(",").join(driver_hints_arr); - } - - String default_driver = driver_hints.get_slice(",", 0); - String default_driver_with_d3d12 = driver_hints_with_d3d12.get_slice(",", 0); - String default_driver_with_metal = driver_hints_with_metal.get_slice(",", 0); - - // For now everything defaults to vulkan when available. This can change in future updates. - GLOBAL_DEF_RST_NOVAL("rendering/rendering_device/driver", default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.windows", PROPERTY_HINT_ENUM, driver_hints_with_d3d12), default_driver_with_d3d12); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.linuxbsd", PROPERTY_HINT_ENUM, driver_hints), default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.android", PROPERTY_HINT_ENUM, driver_hints), default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.ios", PROPERTY_HINT_ENUM, driver_hints_with_metal), default_driver_with_metal); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.macos", PROPERTY_HINT_ENUM, driver_hints_with_metal), default_driver_with_metal); + // RenderingDevice driver overrides per platform. + GLOBAL_DEF_RST("rendering/rendering_device/driver", "vulkan"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.windows", PROPERTY_HINT_ENUM, "vulkan,d3d12"), "vulkan"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.linuxbsd", PROPERTY_HINT_ENUM, "vulkan"), "vulkan"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.android", PROPERTY_HINT_ENUM, "vulkan"), "vulkan"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.ios", PROPERTY_HINT_ENUM, "metal,vulkan"), "metal"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/rendering_device/driver.macos", PROPERTY_HINT_ENUM, "metal,vulkan"), "metal"); GLOBAL_DEF_RST("rendering/rendering_device/fallback_to_vulkan", true); GLOBAL_DEF_RST("rendering/rendering_device/fallback_to_d3d12", true); @@ -2072,24 +2051,14 @@ Error Main::setup(const char *execpath, int argc, char *argv[], bool p_second_ph } { - String driver_hints = ""; - String driver_hints_angle = ""; - String driver_hints_egl = ""; -#ifdef GLES3_ENABLED - driver_hints = "opengl3"; - driver_hints_angle = "opengl3,opengl3_angle"; // macOS, Windows. - driver_hints_egl = "opengl3,opengl3_es"; // Linux. -#endif - - String default_driver = driver_hints.get_slice(",", 0); - - GLOBAL_DEF_RST_NOVAL("rendering/gl_compatibility/driver", default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.windows", PROPERTY_HINT_ENUM, driver_hints_angle), default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.linuxbsd", PROPERTY_HINT_ENUM, driver_hints_egl), default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.web", PROPERTY_HINT_ENUM, driver_hints), default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.android", PROPERTY_HINT_ENUM, driver_hints), default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.ios", PROPERTY_HINT_ENUM, driver_hints), default_driver); - GLOBAL_DEF_RST_NOVAL(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.macos", PROPERTY_HINT_ENUM, driver_hints_angle), default_driver); + // GL Compatibility driver overrides per platform. + GLOBAL_DEF_RST("rendering/gl_compatibility/driver", "opengl3"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.windows", PROPERTY_HINT_ENUM, "opengl3,opengl3_angle"), "opengl3"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.linuxbsd", PROPERTY_HINT_ENUM, "opengl3,opengl3_es"), "opengl3"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.web", PROPERTY_HINT_ENUM, "opengl3"), "opengl3"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.android", PROPERTY_HINT_ENUM, "opengl3"), "opengl3"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.ios", PROPERTY_HINT_ENUM, "opengl3"), "opengl3"); + GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "rendering/gl_compatibility/driver.macos", PROPERTY_HINT_ENUM, "opengl3,opengl3_angle"), "opengl3"); GLOBAL_DEF_RST("rendering/gl_compatibility/nvidia_disable_threaded_optimization", true); GLOBAL_DEF_RST("rendering/gl_compatibility/fallback_to_angle", true); diff --git a/platform/macos/display_server_macos.mm b/platform/macos/display_server_macos.mm index 346faef842a..556c4c966ef 100644 --- a/platform/macos/display_server_macos.mm +++ b/platform/macos/display_server_macos.mm @@ -3791,8 +3791,11 @@ DisplayServerMacOS::DisplayServerMacOS(const String &p_rendering_driver, WindowM #if defined(VULKAN_ENABLED) #if defined(__x86_64__) bool fallback_to_vulkan = GLOBAL_GET("rendering/rendering_device/fallback_to_vulkan"); + if (!fallback_to_vulkan) { + WARN_PRINT("Metal is not supported on Intel Macs, switching to Vulkan."); + } // Metal rendering driver not available on Intel. - if (fallback_to_vulkan && rendering_driver == "metal") { + if (rendering_driver == "metal") { rendering_driver = "vulkan"; OS::get_singleton()->set_current_rendering_driver_name(rendering_driver); } diff --git a/platform/windows/display_server_windows.cpp b/platform/windows/display_server_windows.cpp index 6f71950e2fd..18bbba342b4 100644 --- a/platform/windows/display_server_windows.cpp +++ b/platform/windows/display_server_windows.cpp @@ -6764,24 +6764,30 @@ DisplayServerWindows::DisplayServerWindows(const String &p_rendering_driver, Win _register_raw_input_devices(INVALID_WINDOW_ID); #if defined(RD_ENABLED) + bool fallback_to_vulkan = GLOBAL_GET("rendering/rendering_device/fallback_to_vulkan"); + bool fallback_to_d3d12 = GLOBAL_GET("rendering/rendering_device/fallback_to_d3d12"); + #if defined(VULKAN_ENABLED) if (rendering_driver == "vulkan") { rendering_context = memnew(RenderingContextDriverVulkanWindows); tested_drivers.set_flag(DRIVER_ID_RD_VULKAN); } +#else + fallback_to_d3d12 = true; // Always enable fallback if engine was built w/o other driver support. #endif #if defined(D3D12_ENABLED) if (rendering_driver == "d3d12") { rendering_context = memnew(RenderingContextDriverD3D12); tested_drivers.set_flag(DRIVER_ID_RD_D3D12); } +#else + fallback_to_vulkan = true; // Always enable fallback if engine was built w/o other driver support. #endif if (rendering_context) { if (rendering_context->initialize() != OK) { bool failed = true; #if defined(VULKAN_ENABLED) - bool fallback_to_vulkan = GLOBAL_GET("rendering/rendering_device/fallback_to_vulkan"); if (failed && fallback_to_vulkan && rendering_driver != "vulkan") { memdelete(rendering_context); rendering_context = memnew(RenderingContextDriverVulkanWindows); @@ -6795,7 +6801,6 @@ DisplayServerWindows::DisplayServerWindows(const String &p_rendering_driver, Win } #endif #if defined(D3D12_ENABLED) - bool fallback_to_d3d12 = GLOBAL_GET("rendering/rendering_device/fallback_to_d3d12"); if (failed && fallback_to_d3d12 && rendering_driver != "d3d12") { memdelete(rendering_context); rendering_context = memnew(RenderingContextDriverD3D12);