From bc1b2b96e1e10d5d44d5d3357fb733279b76a609 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Tue, 27 Aug 2019 18:21:16 +0200
Subject: Tweak the default fog depth end to use a fixed value

The previous value (0) was a special case in the fog shader.
It made the shader use the Camera's `far` value as the fog depth end
value, which led to an inconsistency in the fog rendering between
the editor and a running project. This is because the editor camera
uses a `far` property of 500 by default, whereas the Camera node's
`far` property is set to 100 by default.

The new fixed value is equal to the default `far` property in Camera,
which leads to a consistent appearance between the editor and a running
project.

This closes #31686.
---
 doc/classes/Environment.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'doc/classes')

diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml
index 86c1002666..fcbd8a2193 100644
--- a/doc/classes/Environment.xml
+++ b/doc/classes/Environment.xml
@@ -146,10 +146,11 @@
 		<member name="fog_depth_enabled" type="bool" setter="set_fog_depth_enabled" getter="is_fog_depth_enabled" default="true">
 			Enables the fog depth.
 		</member>
-		<member name="fog_depth_end" type="float" setter="set_fog_depth_end" getter="get_fog_depth_end" default="0.0">
+		<member name="fog_depth_end" type="float" setter="set_fog_depth_end" getter="get_fog_depth_end" default="100.0">
+			Fog's depth end distance from the camera. If this value is set to 0, it will be equal to the current camera's [member Camera.far] value.
 		</member>
 		<member name="fog_enabled" type="bool" setter="set_fog_enabled" getter="is_fog_enabled" default="false">
-			Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.
+			Enables the fog. Needs [member fog_height_enabled] and/or [member fog_depth_enabled] to actually display fog.
 		</member>
 		<member name="fog_height_curve" type="float" setter="set_fog_height_curve" getter="get_fog_height_curve" default="1.0">
 			Value defining the fog height intensity.
-- 
cgit v1.2.3