From 2f95efcaafdb3d41560b0d71dffcbef679741528 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 23 Feb 2022 17:44:49 +0100 Subject: [PATCH] Document glow rendering caveats when using GLES3 on mobile (cherry picked from commit 595d67ae8b24a7f6174a655b5618c479d8554b8c) --- doc/classes/Environment.xml | 2 ++ doc/classes/ProjectSettings.xml | 7 ++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index c41d402a7ec..ecef1ef4a69 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -194,6 +194,8 @@ If [code]true[/code], the glow effect is enabled. + [b]Note:[/b] Only effective if [member ProjectSettings.rendering/quality/intended_usage/framebuffer_allocation] is [b]3D[/b] ([i]not[/i] [b]3D Without Effects[/b]). On mobile, [member ProjectSettings.rendering/quality/intended_usage/framebuffer_allocation] defaults to [b]3D Without Effects[/b] by default, so its [code].mobile[/code] override needs to be changed to [b]3D[/b]. + [b]Note:[/b] When using GLES3 on mobile, HDR rendering is disabled by default for performance reasons. This means glow will only be visible if [member glow_hdr_threshold] is decreased below [code]1.0[/code] or if [member glow_bloom] is increased above [code]0.0[/code]. Also consider increasing [member glow_intensity] to [code]1.5[/code]. If you want glow to behave on mobile like it does on desktop (at a performance cost), enable [member ProjectSettings.rendering/quality/depth/hdr]'s [code].mobile[/code] override. The higher threshold of the HDR glow. Areas brighter than this threshold will be clamped for the purposes of the glow effect. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 5be5b9b2a94..66fedd4bd34 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1302,11 +1302,12 @@ [b]Note:[/b] Generally you should only use this option if you encounter bugs when it is set to [code]false[/code], i.e. there are problems with the default method. - If [code]true[/code], allocates the main framebuffer with high dynamic range. High dynamic range allows the use of [Color] values greater than 1. + If [code]true[/code], allocates the root [Viewport]'s framebuffer with high dynamic range. High dynamic range allows the use of [Color] values greater than 1. This must be set to [code]true[/code] for glow rendering to work if [member Environment.glow_hdr_threshold] is greater than or equal to [code]1.0[/code]. [b]Note:[/b] Only available on the GLES3 backend. - Lower-end override for [member rendering/quality/depth/hdr] on mobile devices, due to performance concerns or driver support. + Lower-end override for [member rendering/quality/depth/hdr] on mobile devices, due to performance concerns or driver support. This must be set to [code]true[/code] for glow rendering to work if [member Environment.glow_hdr_threshold] is greater than or equal to [code]1.0[/code]. + [b]Note:[/b] Only available on the GLES3 backend. Disables depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. @@ -1350,7 +1351,7 @@ If [code]true[/code], uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If [code]false[/code], linear mipmap filtering (also called "trilinear filtering") is used. - Strategy used for framebuffer allocation. The simpler it is, the less resources it uses (but the less features it supports). If set to "2D Without Sampling" or "3D Without Effects", sample buffers will not be allocated. This means [code]SCREEN_TEXTURE[/code] and [code]DEPTH_TEXTURE[/code] will not be available in shaders and post-processing effects will not be available in the [Environment]. + Strategy used for framebuffer allocation. The simpler it is, the less resources it uses (but the less features it supports). If set to "2D Without Sampling" or "3D Without Effects", sample buffers will not be allocated. This means [code]SCREEN_TEXTURE[/code] and [code]DEPTH_TEXTURE[/code] will not be available in shaders and post-processing effects such as glow will not be available in [Environment]. Lower-end override for [member rendering/quality/intended_usage/framebuffer_allocation] on mobile devices, due to performance concerns or driver support.