summaryrefslogtreecommitdiff
path: root/src/gfx_type.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2009-06-20 15:48:55 +0000
committeralberth <alberth@openttd.org>2009-06-20 15:48:55 +0000
commitc1ef6abc6a1ffadb9177868f91ddb652426d077d (patch)
treeb56324a7edb968d83639feff393f54c03ced09e5 /src/gfx_type.h
parent0aed5bf7d7558e209ea57e277a85c408176147b6 (diff)
downloadopenttd-c1ef6abc6a1ffadb9177868f91ddb652426d077d.tar.xz
(svn r16606) -Doc: Added/fixed doxygen comments.
Diffstat (limited to 'src/gfx_type.h')
-rw-r--r--src/gfx_type.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/gfx_type.h b/src/gfx_type.h
index 569c78214..7796d19e0 100644
--- a/src/gfx_type.h
+++ b/src/gfx_type.h
@@ -129,6 +129,7 @@ struct CursorVars {
bool vehchain; ///< vehicle chain is dragged
};
+/** Data about how and where to blit pixels. */
struct DrawPixelInfo {
void *dst_ptr;
int left, top, width, height;
@@ -136,6 +137,7 @@ struct DrawPixelInfo {
ZoomLevel zoom;
};
+/** Structure to access the alpha, red, green, and blue channels from a 32 bit number. */
struct Colour {
#if TTD_ENDIAN == TTD_BIG_ENDIAN
uint8 a, r, g, b; ///< colour channels in BE order
@@ -143,7 +145,7 @@ struct Colour {
uint8 b, g, r, a; ///< colour channels in LE order
#endif /* TTD_ENDIAN == TTD_BIG_ENDIAN */
- operator uint32 () const { return *(uint32 *)this; }
+ operator uint32 () const { return *(uint32 *)this; } ///< Conversion of the channel information to a 32 bit number.
};
/** Available font sizes */