summaryrefslogtreecommitdiffstats
path: root/src/graphics/engine/cloud.h
diff options
context:
space:
mode:
authorPiotr Dziwinski <piotrdz@gmail.com>2012-08-13 00:14:42 +0200
committerPiotr Dziwinski <piotrdz@gmail.com>2012-08-13 00:14:42 +0200
commit712154bc4fcfb50c05c57a875e3b2affdc5e2b1b (patch)
tree9b13ef9f64cf272a8c67effdb62c2459306bd167 /src/graphics/engine/cloud.h
parent146ad47e4afbf1fe82763c94c2cd2209285f869f (diff)
downloadcolobot-712154bc4fcfb50c05c57a875e3b2affdc5e2b1b.tar.gz
colobot-712154bc4fcfb50c05c57a875e3b2affdc5e2b1b.tar.bz2
colobot-712154bc4fcfb50c05c57a875e3b2affdc5e2b1b.zip
Rendering functions, documentation
- rewrote the render functions for CEngine, CCloud and CWater - added documentation
Diffstat (limited to 'src/graphics/engine/cloud.h')
-rw-r--r--src/graphics/engine/cloud.h20
1 files changed, 18 insertions, 2 deletions
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: