summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2008-05-04 08:38:21 +0000
committerrubidium <rubidium@openttd.org>2008-05-04 08:38:21 +0000
commit72eb1f100b944902bee8bcc092dfaf0acbdfdd56 (patch)
treee4b71c3df1f4c1e526a1758ffb1d89b3f8d49744
parentd1ddff90d95dda94382790025c7c4f8ac96152c4 (diff)
downloadopenttd-72eb1f100b944902bee8bcc092dfaf0acbdfdd56.tar.xz
(svn r12936) -Doc: a few structs in geometry_type.hpp. Patch by Alberth.
-rw-r--r--src/core/geometry_type.hpp8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/core/geometry_type.hpp b/src/core/geometry_type.hpp
index be89acdb7..6258ffd1d 100644
--- a/src/core/geometry_type.hpp
+++ b/src/core/geometry_type.hpp
@@ -17,16 +17,19 @@
#endif /* __APPLE__ */
+/** Coordinates of a point in 2D */
struct Point {
int x;
int y;
};
+/** Dimensions (a width and height) of a rectangle in 2D */
struct Dimension {
int width;
int height;
};
+/** Specification of a rectangle with absolute coordinates of all edges */
struct Rect {
int left;
int top;
@@ -34,6 +37,10 @@ struct Rect {
int bottom;
};
+/**
+ * Specification of a rectangle with an absolute top-left coordinate and a
+ * (relative) width/height
+ */
struct PointDimension {
int x;
int y;
@@ -41,6 +48,7 @@ struct PointDimension {
int height;
};
+/** A pair of two integers */
struct Pair {
int a;
int b;