summaryrefslogtreecommitdiff
path: root/doc/classes/FogVolume.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-02-28 07:41:35 +0100
committerGitHub <noreply@github.com>2022-02-28 07:41:35 +0100
commit353be6261f1db9c34d322faadfa2807998b3a5d8 (patch)
tree4da7827092fe42d2910d707f2e6e0710b09ce183 /doc/classes/FogVolume.xml
parentbabac6e08cdc290573fa80d3cada471d6d2f8457 (diff)
parent29e85298f5881236e4e9543d3a5807fbd4aebce8 (diff)
Merge pull request #58603 from Calinou/doc-fogvolume-thin-flicker
Document how to fix thin FogVolumes flickering when the camera moves
Diffstat (limited to 'doc/classes/FogVolume.xml')
-rw-r--r--doc/classes/FogVolume.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/FogVolume.xml b/doc/classes/FogVolume.xml
index c869141ef6..d28a6a8783 100644
--- a/doc/classes/FogVolume.xml
+++ b/doc/classes/FogVolume.xml
@@ -12,6 +12,7 @@
<members>
<member name="extents" type="Vector3" setter="set_extents" getter="get_extents" default="Vector3(1, 1, 1)">
Sets the size of the [FogVolume] when [member shape] is [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID] or [constant RenderingServer.FOG_VOLUME_SHAPE_BOX].
+ [b]Note:[/b] Thin fog volumes may appear to flicker when the camera moves or rotates. This can be alleviated by increasing [member ProjectSettings.rendering/environment/volumetric_fog/volume_depth] (at a performance cost) or by decreasing [member Environment.volumetric_fog_length] (at no performance cost, but at the cost of lower fog range). Alternatively, the [FogVolume] can be made thicker and use a lower density in the [member material].
</member>
<member name="material" type="Material" setter="set_material" getter="get_material">
Sets the [Material] to be used by the [FogVolume]. Can be either a [FogMaterial] or a custom [ShaderMaterial].