[PATCH weston 1/6] compositor: document view->transform.* regions

[Pekka Paalanen]

From: Pekka Paalanen <pekka.paalanen at collabora.co.uk>

Signed-off-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
---
 src/compositor.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/compositor.h b/src/compositor.h
index 2d70ad1..c942365 100644
--- a/src/compositor.h
+++ b/src/compositor.h
@@ -802,6 +802,12 @@ struct weston_view {
 	struct {
 		int dirty;
 
+		/* Approximations in global coordinates:
+		 * - boundingbox is guaranteed to include the whole view in
+		 *   the smallest possible single rectangle.
+		 * - opaque is guaranteed to be fully opaque, though not
+		 *   necessarily include all opaque areas.
+		 */
 		pixman_region32_t boundingbox;
 		pixman_region32_t opaque;
 
-- 
2.0.5