From 07b72c9fec70312786b0ed1784b946bf21859e80 Mon Sep 17 00:00:00 2001
From: Colin Snover
Date: Sat, 2 Jul 2016 19:43:19 -0500
Subject: SCI32: Document ScreenItem::_insetRect

---
 engines/sci/graphics/screen_item32.h | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

(limited to 'engines/sci/graphics/screen_item32.h')

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;
 
-- 
cgit v1.2.3