summaryrefslogtreecommitdiff
path: root/src/viewport_type.h
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2008-04-07 20:28:58 +0000
committerrubidium <rubidium@openttd.org>2008-04-07 20:28:58 +0000
commitee02dd7dadb00e51a04b65e38603d77e9cfa1848 (patch)
tree9f8c5c236cf106ef895d27405d1a9d266e338480 /src/viewport_type.h
parentf04ecd2e4a90bc62a6d8728261a8fdf78efdd545 (diff)
downloadopenttd-ee02dd7dadb00e51a04b65e38603d77e9cfa1848.tar.xz
(svn r12619) -Codechange: lots of documentation about window related stuff. Patch by Alberth.
Diffstat (limited to 'src/viewport_type.h')
-rw-r--r--src/viewport_type.h17
1 files changed, 12 insertions, 5 deletions
diff --git a/src/viewport_type.h b/src/viewport_type.h
index 55504ebb6..f43566fbb 100644
--- a/src/viewport_type.h
+++ b/src/viewport_type.h
@@ -10,12 +10,19 @@
#include "window_type.h"
#include "tile_type.h"
+/**
+ * Data structure for viewport, display of a part of the world
+ */
struct ViewPort {
- int left,top; // screen coordinates for the viewport
- int width, height; // screen width/height for the viewport
+ int left; ///< Screen coordinate left egde of the viewport
+ int top; ///< Screen coordinate top edge of the viewport
+ int width; ///< Screen width of the viewport
+ int height; ///< Screen height of the viewport
- int virtual_left, virtual_top; // virtual coordinates
- int virtual_width, virtual_height; // these are just width << zoom, height << zoom
+ int virtual_left; ///< Virtual left coordinate
+ int virtual_top; ///< Virtual top coordinate
+ int virtual_width; ///< width << zoom
+ int virtual_height; ///< height << zoom
ZoomLevel zoom;
};
@@ -58,7 +65,7 @@ enum ViewportHighlightMode {
VHM_RAIL = 5, ///< rail pieces
};
-/* highlighting draw styles */
+/** Highlighting draw styles */
enum HighLightStyle {
HT_NONE = 0x00,
HT_RECT = 0x80,