aboutsummaryrefslogtreecommitdiff
path: root/engines
diff options
context:
space:
mode:
authorColin Snover2016-07-02 19:43:19 -0500
committerColin Snover2016-07-02 22:28:37 -0500
commit07b72c9fec70312786b0ed1784b946bf21859e80 (patch)
treedd0ee7a1a953e0738c786a0be9f49f11e94c0158 /engines
parent79b0309fd1418d17e1f4c95b0db3d527cd528205 (diff)
downloadscummvm-rg350-07b72c9fec70312786b0ed1784b946bf21859e80.tar.gz
scummvm-rg350-07b72c9fec70312786b0ed1784b946bf21859e80.tar.bz2
scummvm-rg350-07b72c9fec70312786b0ed1784b946bf21859e80.zip
SCI32: Document ScreenItem::_insetRect
Diffstat (limited to 'engines')
-rw-r--r--engines/sci/graphics/screen_item32.h18
1 files changed, 13 insertions, 5 deletions
diff --git a/engines/sci/graphics/screen_item32.h b/engines/sci/graphics/screen_item32.h
index 2e44e418ce..caa7a9d725 100644
--- a/engines/sci/graphics/screen_item32.h
+++ b/engines/sci/graphics/screen_item32.h
@@ -88,15 +88,23 @@ private:
Common::Rect _screenItemRect;
/**
- * TODO: Document
+ * If true, the `_insetRect` rectangle will be used
+ * when calculating the dimensions of the screen item
+ * instead of the cel's intrinsic width and height.
+ *
+ * In other words, using an inset rect means that
+ * the cel is cropped to the dimensions given in
+ * `_insetRect`.
*/
bool _useInsetRect;
/**
- * TODO: Documentation
- * The insetRect is also used to describe the fill
- * rectangle of a screen item that is drawn using
- * CelObjColor.
+ * The cropping rectangle used when `_useInsetRect`
+ * is true.
+ *
+ * `_insetRect` is also used to describe the fill
+ * rectangle of a screen item with a CelObjColor
+ * cel.
*/
Common::Rect _insetRect;