From 712154bc4fcfb50c05c57a875e3b2affdc5e2b1b Mon Sep 17 00:00:00 2001
From: Piotr Dziwinski <piotrdz@gmail.com>
Date: Mon, 13 Aug 2012 00:14:42 +0200
Subject: Rendering functions, documentation

- rewrote the render functions for CEngine, CCloud and CWater
- added documentation
---
 src/graphics/engine/cloud.h | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

(limited to 'src/graphics/engine/cloud.h')

diff --git a/src/graphics/engine/cloud.h b/src/graphics/engine/cloud.h
index 079f77b..abfaf26 100644
--- a/src/graphics/engine/cloud.h
+++ b/src/graphics/engine/cloud.h
@@ -40,12 +40,19 @@ namespace Gfx {
 class CEngine;
 class CTerrain;
 
+/**
+ * \struct CloudLine
+ * \brief Cloud strip
+ */
 struct CloudLine
 {
-    //! Beginning
+    //@{
+    //! Beginning (terrain coordinates)
     short       x, y;
-    //! In length x
+    //@}
+    //! Length in X direction (terrain coordinates)
     short       len;
+    //! X (1, 2) and Z coordinates (world coordinates)
     float       px1, px2, pz;
 
     CloudLine()
@@ -57,6 +64,15 @@ struct CloudLine
 };
 
 
+/**
+ * \class CCloud
+ * \brief Cloud layer renderer
+ *
+ * Renders the cloud layer as fog. Cloud layer is similar to water layer
+ * - it occurs only at specified level of terrain. Cloud map is created
+ * the same way water is created. CloudLine structs are used to specify
+ * lines in X direction in XY terrain coordinates.
+ */
 class CCloud
 {
 public:
-- 
cgit v1.2.3-1-g7c22