Update and improve documentation

[libs/gl.git] / source / effects / sky.h

diff --git a/source/effects/sky.h b/source/effects/sky.h
index 0152729a0ec8cf8dbb5ba88c5fc529ad5fd895c2..7d8933d4a65f4a6facbb7799fbb99f59293bc6bb 100644 (file)
--- a/source/effects/sky.h
+++ b/source/effects/sky.h
@@ -13,9 +13,14 @@ class Mesh;
 class Program;
 
 /**
-Renders a procedurally generated sky at the background.  Based on the paper
-"A Scalable and Production Ready Sky and Atmosphere Rendering Technique" by
-Sébastien Hillaire (https://sebh.github.io/publications/egsr2020.pdf).
+Renders a procedurally generated sky at the background.
+
+In addition to the background, the transmittance of the sun light is calculated
+to produce realistic lighting at dawn and dusk.
+
+Based on the techniques described in "A Scalable and Production Ready Sky and
+Atmosphere Rendering Technique" by Sébastien Hillaire
+(https://sebh.github.io/publications/egsr2020.pdf).
 */
 class Sky: public Effect
 {